Package com.mypurecloud.sdk.v2.model

Class WorkPlanShift

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

  • Constructor Details

    • WorkPlanShift

      public WorkPlanShift()

    • WorkPlanShift

      public WorkPlanShift(Boolean initWithEmptyList)

  • Method Details

    • name

      public WorkPlanShift name(String name)
      Name of the shift

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • days

      public WorkPlanShift days(SetWrapperDayOfWeek days)
      Days of the week applicable for this shift

    • getDays

      public SetWrapperDayOfWeek getDays()

    • setDays

      public void setDays(SetWrapperDayOfWeek days)

    • flexibleStartTime

      public WorkPlanShift flexibleStartTime(Boolean flexibleStartTime)
      Whether the start time of the shift is flexible

    • getFlexibleStartTime

      public Boolean getFlexibleStartTime()

    • setFlexibleStartTime

      public void setFlexibleStartTime(Boolean flexibleStartTime)

    • exactStartTimeMinutesFromMidnight

      public WorkPlanShift exactStartTimeMinutesFromMidnight(Integer exactStartTimeMinutesFromMidnight)
      Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false

    • getExactStartTimeMinutesFromMidnight

      public Integer getExactStartTimeMinutesFromMidnight()

    • setExactStartTimeMinutesFromMidnight

      public void setExactStartTimeMinutesFromMidnight(Integer exactStartTimeMinutesFromMidnight)

    • earliestStartTimeMinutesFromMidnight

      public WorkPlanShift earliestStartTimeMinutesFromMidnight(Integer earliestStartTimeMinutesFromMidnight)
      Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true

    • getEarliestStartTimeMinutesFromMidnight

      public Integer getEarliestStartTimeMinutesFromMidnight()

    • setEarliestStartTimeMinutesFromMidnight

      public void setEarliestStartTimeMinutesFromMidnight(Integer earliestStartTimeMinutesFromMidnight)

    • latestStartTimeMinutesFromMidnight

      public WorkPlanShift latestStartTimeMinutesFromMidnight(Integer latestStartTimeMinutesFromMidnight)
      Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true

    • getLatestStartTimeMinutesFromMidnight

      public Integer getLatestStartTimeMinutesFromMidnight()

    • setLatestStartTimeMinutesFromMidnight

      public void setLatestStartTimeMinutesFromMidnight(Integer latestStartTimeMinutesFromMidnight)

    • constrainStopTime

      public WorkPlanShift constrainStopTime(Boolean constrainStopTime)
      Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead

    • getConstrainStopTime

      public Boolean getConstrainStopTime()

    • setConstrainStopTime

      public void setConstrainStopTime(Boolean constrainStopTime)

    • constrainLatestStopTime

      public WorkPlanShift constrainLatestStopTime(Boolean constrainLatestStopTime)
      Whether the latest stop time constraint for the shift is enabled

    • getConstrainLatestStopTime

      public Boolean getConstrainLatestStopTime()

    • setConstrainLatestStopTime

      public void setConstrainLatestStopTime(Boolean constrainLatestStopTime)

    • latestStopTimeMinutesFromMidnight

      public WorkPlanShift latestStopTimeMinutesFromMidnight(Integer latestStopTimeMinutesFromMidnight)
      Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true

    • getLatestStopTimeMinutesFromMidnight

      public Integer getLatestStopTimeMinutesFromMidnight()

    • setLatestStopTimeMinutesFromMidnight

      public void setLatestStopTimeMinutesFromMidnight(Integer latestStopTimeMinutesFromMidnight)

    • constrainEarliestStopTime

      public WorkPlanShift constrainEarliestStopTime(Boolean constrainEarliestStopTime)
      Whether the earliest stop time constraint for the shift is enabled

    • getConstrainEarliestStopTime

      public Boolean getConstrainEarliestStopTime()

    • setConstrainEarliestStopTime

      public void setConstrainEarliestStopTime(Boolean constrainEarliestStopTime)

    • earliestStopTimeMinutesFromMidnight

      public WorkPlanShift earliestStopTimeMinutesFromMidnight(Integer earliestStopTimeMinutesFromMidnight)
      This is the earliest time a shift can end

    • getEarliestStopTimeMinutesFromMidnight

      public Integer getEarliestStopTimeMinutesFromMidnight()

    • setEarliestStopTimeMinutesFromMidnight

      public void setEarliestStopTimeMinutesFromMidnight(Integer earliestStopTimeMinutesFromMidnight)

    • startIncrementMinutes

      public WorkPlanShift startIncrementMinutes(Integer startIncrementMinutes)
      Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true

    • getStartIncrementMinutes

      public Integer getStartIncrementMinutes()

    • setStartIncrementMinutes

      public void setStartIncrementMinutes(Integer startIncrementMinutes)

    • flexiblePaidTime

      public WorkPlanShift flexiblePaidTime(Boolean flexiblePaidTime)
      Whether the paid time setting for the shift is flexible

    • getFlexiblePaidTime

      public Boolean getFlexiblePaidTime()

    • setFlexiblePaidTime

      public void setFlexiblePaidTime(Boolean flexiblePaidTime)

    • exactPaidTimeMinutes

      public WorkPlanShift exactPaidTimeMinutes(Integer exactPaidTimeMinutes)
      Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false

    • getExactPaidTimeMinutes

      public Integer getExactPaidTimeMinutes()

    • setExactPaidTimeMinutes

      public void setExactPaidTimeMinutes(Integer exactPaidTimeMinutes)

    • minimumPaidTimeMinutes

      public WorkPlanShift minimumPaidTimeMinutes(Integer minimumPaidTimeMinutes)
      Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true

    • getMinimumPaidTimeMinutes

      public Integer getMinimumPaidTimeMinutes()

    • setMinimumPaidTimeMinutes

      public void setMinimumPaidTimeMinutes(Integer minimumPaidTimeMinutes)

    • maximumPaidTimeMinutes

      public WorkPlanShift maximumPaidTimeMinutes(Integer maximumPaidTimeMinutes)
      Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true

    • getMaximumPaidTimeMinutes

      public Integer getMaximumPaidTimeMinutes()

    • setMaximumPaidTimeMinutes

      public void setMaximumPaidTimeMinutes(Integer maximumPaidTimeMinutes)

    • constrainContiguousWorkTime

      public WorkPlanShift constrainContiguousWorkTime(Boolean constrainContiguousWorkTime)
      Whether the contiguous time constraint for the shift is enabled

    • getConstrainContiguousWorkTime

      public Boolean getConstrainContiguousWorkTime()

    • setConstrainContiguousWorkTime

      public void setConstrainContiguousWorkTime(Boolean constrainContiguousWorkTime)

    • minimumContiguousWorkTimeMinutes

      public WorkPlanShift minimumContiguousWorkTimeMinutes(Integer minimumContiguousWorkTimeMinutes)
      Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true

    • getMinimumContiguousWorkTimeMinutes

      public Integer getMinimumContiguousWorkTimeMinutes()

    • setMinimumContiguousWorkTimeMinutes

      public void setMinimumContiguousWorkTimeMinutes(Integer minimumContiguousWorkTimeMinutes)

    • maximumContiguousWorkTimeMinutes

      public WorkPlanShift maximumContiguousWorkTimeMinutes(Integer maximumContiguousWorkTimeMinutes)
      Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true

    • getMaximumContiguousWorkTimeMinutes

      public Integer getMaximumContiguousWorkTimeMinutes()

    • setMaximumContiguousWorkTimeMinutes

      public void setMaximumContiguousWorkTimeMinutes(Integer maximumContiguousWorkTimeMinutes)

    • constrainDayOff

      public WorkPlanShift constrainDayOff(Boolean constrainDayOff)
      Whether day off rule is enabled

    • getConstrainDayOff

      public Boolean getConstrainDayOff()

    • setConstrainDayOff

      public void setConstrainDayOff(Boolean constrainDayOff)

    • dayOffRule

      public WorkPlanShift dayOffRule(WorkPlanShift.DayOffRuleEnum dayOffRule)
      The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true

    • getDayOffRule

      public WorkPlanShift.DayOffRuleEnum getDayOffRule()

    • setDayOffRule

      public void setDayOffRule(WorkPlanShift.DayOffRuleEnum dayOffRule)

    • planningPeriodConstraints

      public WorkPlanShift planningPeriodConstraints(PlanningPeriodShiftConstraints planningPeriodConstraints)
      Planning period constraints

    • getPlanningPeriodConstraints

      public PlanningPeriodShiftConstraints getPlanningPeriodConstraints()

    • setPlanningPeriodConstraints

      public void setPlanningPeriodConstraints(PlanningPeriodShiftConstraints planningPeriodConstraints)

    • activities

      public WorkPlanShift activities(List<WorkPlanActivity> activities)
      Activities configured for this shift

    • getActivities

      public List<WorkPlanActivity> getActivities()

    • setActivities

      public void setActivities(List<WorkPlanActivity> activities)

    • id

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

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • delete

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

    • getDelete

      public Boolean getDelete()

    • setDelete

      public void setDelete(Boolean delete)

    • validationId

      public WorkPlanShift validationId(String validationId)
      ID of shift 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