Class ShiftTradeResponse

java.lang.Object
com.mypurecloud.sdk.v2.model.ShiftTradeResponse
All Implemented Interfaces:
Serializable

public class ShiftTradeResponse extends Object implements Serializable
ShiftTradeResponse
See Also:
  • Constructor Details

    • ShiftTradeResponse

      public ShiftTradeResponse()
    • ShiftTradeResponse

      public ShiftTradeResponse(Boolean initWithEmptyList)
  • Method Details

    • id

      public ShiftTradeResponse id(String id)
      The ID of this shift trade
    • getId

      public String getId()
    • setId

      public void setId(String id)
    • weekDate

      public ShiftTradeResponse weekDate(LocalDate weekDate)
      The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
    • getWeekDate

      public LocalDate getWeekDate()
    • setWeekDate

      public void setWeekDate(LocalDate weekDate)
    • schedule

      A reference to the associated schedule
    • getSchedule

      public BuScheduleReferenceForMuRoute getSchedule()
    • setSchedule

      public void setSchedule(BuScheduleReferenceForMuRoute schedule)
    • state

      The state of this shift trade
    • getState

      public ShiftTradeResponse.StateEnum getState()
    • setState

      public void setState(ShiftTradeResponse.StateEnum state)
    • initiatingUser

      public ShiftTradeResponse initiatingUser(UserReference initiatingUser)
      The user who initiated this trade
    • getInitiatingUser

      public UserReference getInitiatingUser()
    • setInitiatingUser

      public void setInitiatingUser(UserReference initiatingUser)
    • initiatingShiftId

      public ShiftTradeResponse initiatingShiftId(String initiatingShiftId)
      The ID of the shift offered for trade by the initiating user
    • getInitiatingShiftId

      public String getInitiatingShiftId()
    • setInitiatingShiftId

      public void setInitiatingShiftId(String initiatingShiftId)
    • initiatingShiftStart

      public ShiftTradeResponse initiatingShiftStart(Date initiatingShiftStart)
      The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getInitiatingShiftStart

      public Date getInitiatingShiftStart()
    • setInitiatingShiftStart

      public void setInitiatingShiftStart(Date initiatingShiftStart)
    • initiatingShiftEnd

      public ShiftTradeResponse initiatingShiftEnd(Date initiatingShiftEnd)
      The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getInitiatingShiftEnd

      public Date getInitiatingShiftEnd()
    • setInitiatingShiftEnd

      public void setInitiatingShiftEnd(Date initiatingShiftEnd)
    • receivingWeekDate

      public ShiftTradeResponse receivingWeekDate(LocalDate receivingWeekDate)
      The start week date of the receiving shift in yyyy-MM-dd format for a cross-week shift trade or null otherwise. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
    • getReceivingWeekDate

      public LocalDate getReceivingWeekDate()
    • setReceivingWeekDate

      public void setReceivingWeekDate(LocalDate receivingWeekDate)
    • receivingUser

      public ShiftTradeResponse receivingUser(UserReference receivingUser)
      The user matching the trade, or if the state is not 'Matched', the user to whom the trade request was sent
    • getReceivingUser

      public UserReference getReceivingUser()
    • setReceivingUser

      public void setReceivingUser(UserReference receivingUser)
    • receivingShiftId

      public ShiftTradeResponse receivingShiftId(String receivingShiftId)
      The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift
    • getReceivingShiftId

      public String getReceivingShiftId()
    • setReceivingShiftId

      public void setReceivingShiftId(String receivingShiftId)
    • receivingShiftStart

      public ShiftTradeResponse receivingShiftStart(Date receivingShiftStart)
      The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getReceivingShiftStart

      public Date getReceivingShiftStart()
    • setReceivingShiftStart

      public void setReceivingShiftStart(Date receivingShiftStart)
    • receivingShiftEnd

      public ShiftTradeResponse receivingShiftEnd(Date receivingShiftEnd)
      The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getReceivingShiftEnd

      public Date getReceivingShiftEnd()
    • setReceivingShiftEnd

      public void setReceivingShiftEnd(Date receivingShiftEnd)
    • expiration

      public ShiftTradeResponse expiration(Date expiration)
      When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getExpiration

      public Date getExpiration()
    • setExpiration

      public void setExpiration(Date expiration)
    • oneSided

      public ShiftTradeResponse oneSided(Boolean oneSided)
      Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)
    • getOneSided

      public Boolean getOneSided()
    • setOneSided

      public void setOneSided(Boolean oneSided)
    • acceptableIntervals

      public ShiftTradeResponse acceptableIntervals(List<String> acceptableIntervals)
      Time frames when the initiating user is willing to accept trades. Empty means giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
    • getAcceptableIntervals

      public List<String> getAcceptableIntervals()
    • setAcceptableIntervals

      public void setAcceptableIntervals(List<String> acceptableIntervals)
    • reviewedBy

      public ShiftTradeResponse reviewedBy(UserReference reviewedBy)
      The user who reviewed this shift trade. The id may be 'System' if it was an automated process
    • getReviewedBy

      public UserReference getReviewedBy()
    • setReviewedBy

      public void setReviewedBy(UserReference reviewedBy)
    • reviewedDate

      public ShiftTradeResponse reviewedDate(Date reviewedDate)
      The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getReviewedDate

      public Date getReviewedDate()
    • setReviewedDate

      public void setReviewedDate(Date reviewedDate)
    • metadata

      public ShiftTradeResponse metadata(WfmVersionedEntityMetadata metadata)
      Version data for this trade
    • getMetadata

      public WfmVersionedEntityMetadata getMetadata()
    • setMetadata

      public void setMetadata(WfmVersionedEntityMetadata metadata)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object