Package com.mypurecloud.sdk.v2.model

Class WorkPlanActivity

java.lang.Object
com.mypurecloud.sdk.v2.model.WorkPlanActivity
All Implemented Interfaces:
Serializable
public class WorkPlanActivity extends Object implements Serializable
WorkPlanActivity
See Also:

  • Constructor Details

    • WorkPlanActivity

      public WorkPlanActivity()

    • WorkPlanActivity

      public WorkPlanActivity(Boolean initWithEmptyList)

  • Method Details

    • activityCodeId

      public WorkPlanActivity activityCodeId(String activityCodeId)
      ID of the activity code associated with this activity

    • getActivityCodeId

      public String getActivityCodeId()

    • setActivityCodeId

      public void setActivityCodeId(String activityCodeId)

    • description

      public WorkPlanActivity description(String description)
      Description of the activity

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • lengthMinutes

      public WorkPlanActivity lengthMinutes(Integer lengthMinutes)
      Length of the activity in minutes

    • getLengthMinutes

      public Integer getLengthMinutes()

    • setLengthMinutes

      public void setLengthMinutes(Integer lengthMinutes)

    • startTimeIsRelativeToShiftStart

      public WorkPlanActivity startTimeIsRelativeToShiftStart(Boolean startTimeIsRelativeToShiftStart)
      Whether the start time of the activity is relative to the start time of the shift it belongs to

    • getStartTimeIsRelativeToShiftStart

      public Boolean getStartTimeIsRelativeToShiftStart()

    • setStartTimeIsRelativeToShiftStart

      public void setStartTimeIsRelativeToShiftStart(Boolean startTimeIsRelativeToShiftStart)

    • flexibleStartTime

      public WorkPlanActivity flexibleStartTime(Boolean flexibleStartTime)
      Whether the start time of the activity is flexible

    • getFlexibleStartTime

      public Boolean getFlexibleStartTime()

    • setFlexibleStartTime

      public void setFlexibleStartTime(Boolean flexibleStartTime)

    • earliestStartTimeMinutes

      public WorkPlanActivity earliestStartTimeMinutes(Integer earliestStartTimeMinutes)
      Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true

    • getEarliestStartTimeMinutes

      public Integer getEarliestStartTimeMinutes()

    • setEarliestStartTimeMinutes

      public void setEarliestStartTimeMinutes(Integer earliestStartTimeMinutes)

    • latestStartTimeMinutes

      public WorkPlanActivity latestStartTimeMinutes(Integer latestStartTimeMinutes)
      Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true

    • getLatestStartTimeMinutes

      public Integer getLatestStartTimeMinutes()

    • setLatestStartTimeMinutes

      public void setLatestStartTimeMinutes(Integer latestStartTimeMinutes)

    • exactStartTimeMinutes

      public WorkPlanActivity exactStartTimeMinutes(Integer exactStartTimeMinutes)
      Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false

    • getExactStartTimeMinutes

      public Integer getExactStartTimeMinutes()

    • setExactStartTimeMinutes

      public void setExactStartTimeMinutes(Integer exactStartTimeMinutes)

    • startTimeIncrementMinutes

      public WorkPlanActivity startTimeIncrementMinutes(Integer startTimeIncrementMinutes)
      Increment in offset minutes that would contribute to different possible start times for the activity

    • getStartTimeIncrementMinutes

      public Integer getStartTimeIncrementMinutes()

    • setStartTimeIncrementMinutes

      public void setStartTimeIncrementMinutes(Integer startTimeIncrementMinutes)

    • countsAsPaidTime

      public WorkPlanActivity countsAsPaidTime(Boolean countsAsPaidTime)
      Whether the activity is paid

    • getCountsAsPaidTime

      public Boolean getCountsAsPaidTime()

    • setCountsAsPaidTime

      public void setCountsAsPaidTime(Boolean countsAsPaidTime)

    • countsAsContiguousWorkTime

      public WorkPlanActivity countsAsContiguousWorkTime(Boolean countsAsContiguousWorkTime)
      Whether the activity duration is counted towards contiguous work time

    • getCountsAsContiguousWorkTime

      public Boolean getCountsAsContiguousWorkTime()

    • setCountsAsContiguousWorkTime

      public void setCountsAsContiguousWorkTime(Boolean countsAsContiguousWorkTime)

    • minimumLengthFromShiftStartMinutes

      public WorkPlanActivity minimumLengthFromShiftStartMinutes(Integer minimumLengthFromShiftStartMinutes)
      The minimum duration between shift start and shift item (e.g., break or meal) start in minutes

    • getMinimumLengthFromShiftStartMinutes

      public Integer getMinimumLengthFromShiftStartMinutes()

    • setMinimumLengthFromShiftStartMinutes

      public void setMinimumLengthFromShiftStartMinutes(Integer minimumLengthFromShiftStartMinutes)

    • minimumLengthFromShiftEndMinutes

      public WorkPlanActivity minimumLengthFromShiftEndMinutes(Integer minimumLengthFromShiftEndMinutes)
      The minimum duration between shift item (e.g., break or meal) end and shift end in minutes

    • getMinimumLengthFromShiftEndMinutes

      public Integer getMinimumLengthFromShiftEndMinutes()

    • setMinimumLengthFromShiftEndMinutes

      public void setMinimumLengthFromShiftEndMinutes(Integer minimumLengthFromShiftEndMinutes)

    • maximumLengthFromShiftEndMinutes

      public WorkPlanActivity maximumLengthFromShiftEndMinutes(Integer maximumLengthFromShiftEndMinutes)
      The maximum duration between shift item (e.g., break or meal) end and shift end in minutes

    • getMaximumLengthFromShiftEndMinutes

      public Integer getMaximumLengthFromShiftEndMinutes()

    • setMaximumLengthFromShiftEndMinutes

      public void setMaximumLengthFromShiftEndMinutes(Integer maximumLengthFromShiftEndMinutes)

    • id

      public WorkPlanActivity id(String id)
      ID of the activity. This is required only for the case of updating an existing activity

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • delete

      public WorkPlanActivity delete(Boolean delete)
      If marked true for updating an existing activity, the activity will be permanently deleted

    • getDelete

      public Boolean getDelete()

    • setDelete

      public void setDelete(Boolean delete)

    • validationId

      public WorkPlanActivity validationId(String validationId)
      ID of the activity in the context of work plan validation

    • getValidationId

      public String getValidationId()

    • setValidationId

      public void setValidationId(String validationId)

    • 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