Package com.mypurecloud.sdk.v2.model

Class WorkPlan

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

  • Constructor Details

    • WorkPlan

      public WorkPlan()

    • WorkPlan

      public WorkPlan(Boolean initWithEmptyList)

  • Method Details

    • id

      public WorkPlan id(String id)
      The globally unique identifier for the object.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

      public WorkPlan name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • enabled

      public WorkPlan enabled(Boolean enabled)
      Whether the work plan is enabled for scheduling

    • getEnabled

      public Boolean getEnabled()

    • setEnabled

      public void setEnabled(Boolean enabled)

    • getValid

      public Boolean getValid()

    • constrainWeeklyPaidTime

      public WorkPlan constrainWeeklyPaidTime(Boolean constrainWeeklyPaidTime)
      Whether the weekly paid time constraint is enabled for this work plan

    • getConstrainWeeklyPaidTime

      public Boolean getConstrainWeeklyPaidTime()

    • setConstrainWeeklyPaidTime

      public void setConstrainWeeklyPaidTime(Boolean constrainWeeklyPaidTime)

    • flexibleWeeklyPaidTime

      public WorkPlan flexibleWeeklyPaidTime(Boolean flexibleWeeklyPaidTime)
      Whether the weekly paid time constraint is flexible for this work plan

    • getFlexibleWeeklyPaidTime

      public Boolean getFlexibleWeeklyPaidTime()

    • setFlexibleWeeklyPaidTime

      public void setFlexibleWeeklyPaidTime(Boolean flexibleWeeklyPaidTime)

    • weeklyExactPaidMinutes

      public WorkPlan weeklyExactPaidMinutes(Integer weeklyExactPaidMinutes)
      Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false

    • getWeeklyExactPaidMinutes

      public Integer getWeeklyExactPaidMinutes()

    • setWeeklyExactPaidMinutes

      public void setWeeklyExactPaidMinutes(Integer weeklyExactPaidMinutes)

    • weeklyMinimumPaidMinutes

      public WorkPlan weeklyMinimumPaidMinutes(Integer weeklyMinimumPaidMinutes)
      Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true

    • getWeeklyMinimumPaidMinutes

      public Integer getWeeklyMinimumPaidMinutes()

    • setWeeklyMinimumPaidMinutes

      public void setWeeklyMinimumPaidMinutes(Integer weeklyMinimumPaidMinutes)

    • weeklyMaximumPaidMinutes

      public WorkPlan weeklyMaximumPaidMinutes(Integer weeklyMaximumPaidMinutes)
      Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true

    • getWeeklyMaximumPaidMinutes

      public Integer getWeeklyMaximumPaidMinutes()

    • setWeeklyMaximumPaidMinutes

      public void setWeeklyMaximumPaidMinutes(Integer weeklyMaximumPaidMinutes)

    • constrainPaidTimeGranularity

      public WorkPlan constrainPaidTimeGranularity(Boolean constrainPaidTimeGranularity)
      Whether paid time granularity is constrained for this work plan

    • getConstrainPaidTimeGranularity

      public Boolean getConstrainPaidTimeGranularity()

    • setConstrainPaidTimeGranularity

      public void setConstrainPaidTimeGranularity(Boolean constrainPaidTimeGranularity)

    • paidTimeGranularityMinutes

      public WorkPlan paidTimeGranularityMinutes(Integer paidTimeGranularityMinutes)
      Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true

    • getPaidTimeGranularityMinutes

      public Integer getPaidTimeGranularityMinutes()

    • setPaidTimeGranularityMinutes

      public void setPaidTimeGranularityMinutes(Integer paidTimeGranularityMinutes)

    • constrainMinimumTimeBetweenShifts

      public WorkPlan constrainMinimumTimeBetweenShifts(Boolean constrainMinimumTimeBetweenShifts)
      Whether the minimum time between shifts constraint is enabled for this work plan

    • getConstrainMinimumTimeBetweenShifts

      public Boolean getConstrainMinimumTimeBetweenShifts()

    • setConstrainMinimumTimeBetweenShifts

      public void setConstrainMinimumTimeBetweenShifts(Boolean constrainMinimumTimeBetweenShifts)

    • minimumTimeBetweenShiftsMinutes

      public WorkPlan minimumTimeBetweenShiftsMinutes(Integer minimumTimeBetweenShiftsMinutes)
      Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true

    • getMinimumTimeBetweenShiftsMinutes

      public Integer getMinimumTimeBetweenShiftsMinutes()

    • setMinimumTimeBetweenShiftsMinutes

      public void setMinimumTimeBetweenShiftsMinutes(Integer minimumTimeBetweenShiftsMinutes)

    • maximumDays

      public WorkPlan maximumDays(Integer maximumDays)
      Maximum number days in a week allowed to be scheduled for this work plan

    • getMaximumDays

      public Integer getMaximumDays()

    • setMaximumDays

      public void setMaximumDays(Integer maximumDays)

    • minimumConsecutiveNonWorkingMinutesPerWeek

      public WorkPlan minimumConsecutiveNonWorkingMinutesPerWeek(Integer minimumConsecutiveNonWorkingMinutesPerWeek)
      Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off

    • getMinimumConsecutiveNonWorkingMinutesPerWeek

      public Integer getMinimumConsecutiveNonWorkingMinutesPerWeek()

    • setMinimumConsecutiveNonWorkingMinutesPerWeek

      public void setMinimumConsecutiveNonWorkingMinutesPerWeek(Integer minimumConsecutiveNonWorkingMinutesPerWeek)

    • constrainMaximumConsecutiveWorkingWeekends

      public WorkPlan constrainMaximumConsecutiveWorkingWeekends(Boolean constrainMaximumConsecutiveWorkingWeekends)
      Whether to constrain the maximum consecutive working weekends

    • getConstrainMaximumConsecutiveWorkingWeekends

      public Boolean getConstrainMaximumConsecutiveWorkingWeekends()

    • setConstrainMaximumConsecutiveWorkingWeekends

      public void setConstrainMaximumConsecutiveWorkingWeekends(Boolean constrainMaximumConsecutiveWorkingWeekends)

    • maximumConsecutiveWorkingWeekends

      public WorkPlan maximumConsecutiveWorkingWeekends(Integer maximumConsecutiveWorkingWeekends)
      The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work

    • getMaximumConsecutiveWorkingWeekends

      public Integer getMaximumConsecutiveWorkingWeekends()

    • setMaximumConsecutiveWorkingWeekends

      public void setMaximumConsecutiveWorkingWeekends(Integer maximumConsecutiveWorkingWeekends)

    • minimumWorkingDaysPerWeek

      public WorkPlan minimumWorkingDaysPerWeek(Integer minimumWorkingDaysPerWeek)
      The minimum number of days that agents assigned to a work plan must work per week

    • getMinimumWorkingDaysPerWeek

      public Integer getMinimumWorkingDaysPerWeek()

    • setMinimumWorkingDaysPerWeek

      public void setMinimumWorkingDaysPerWeek(Integer minimumWorkingDaysPerWeek)

    • constrainMaximumConsecutiveWorkingDays

      public WorkPlan constrainMaximumConsecutiveWorkingDays(Boolean constrainMaximumConsecutiveWorkingDays)
      Whether to constrain the maximum consecutive working days

    • getConstrainMaximumConsecutiveWorkingDays

      public Boolean getConstrainMaximumConsecutiveWorkingDays()

    • setConstrainMaximumConsecutiveWorkingDays

      public void setConstrainMaximumConsecutiveWorkingDays(Boolean constrainMaximumConsecutiveWorkingDays)

    • maximumConsecutiveWorkingDays

      public WorkPlan maximumConsecutiveWorkingDays(Integer maximumConsecutiveWorkingDays)
      The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true

    • getMaximumConsecutiveWorkingDays

      public Integer getMaximumConsecutiveWorkingDays()

    • setMaximumConsecutiveWorkingDays

      public void setMaximumConsecutiveWorkingDays(Integer maximumConsecutiveWorkingDays)

    • minimumShiftStartDistanceMinutes

      public WorkPlan minimumShiftStartDistanceMinutes(Integer minimumShiftStartDistanceMinutes)
      The time period in minutes for the duration between the start times of two consecutive working days

    • getMinimumShiftStartDistanceMinutes

      public Integer getMinimumShiftStartDistanceMinutes()

    • setMinimumShiftStartDistanceMinutes

      public void setMinimumShiftStartDistanceMinutes(Integer minimumShiftStartDistanceMinutes)

    • minimumDaysOffPerPlanningPeriod

      public WorkPlan minimumDaysOffPerPlanningPeriod(Integer minimumDaysOffPerPlanningPeriod)
      Minimum days off in the planning period

    • getMinimumDaysOffPerPlanningPeriod

      public Integer getMinimumDaysOffPerPlanningPeriod()

    • setMinimumDaysOffPerPlanningPeriod

      public void setMinimumDaysOffPerPlanningPeriod(Integer minimumDaysOffPerPlanningPeriod)

    • maximumDaysOffPerPlanningPeriod

      public WorkPlan maximumDaysOffPerPlanningPeriod(Integer maximumDaysOffPerPlanningPeriod)
      Maximum days off in the planning period

    • getMaximumDaysOffPerPlanningPeriod

      public Integer getMaximumDaysOffPerPlanningPeriod()

    • setMaximumDaysOffPerPlanningPeriod

      public void setMaximumDaysOffPerPlanningPeriod(Integer maximumDaysOffPerPlanningPeriod)

    • minimumPaidMinutesPerPlanningPeriod

      public WorkPlan minimumPaidMinutesPerPlanningPeriod(Integer minimumPaidMinutesPerPlanningPeriod)
      Minimum paid minutes in the planning period

    • getMinimumPaidMinutesPerPlanningPeriod

      public Integer getMinimumPaidMinutesPerPlanningPeriod()

    • setMinimumPaidMinutesPerPlanningPeriod

      public void setMinimumPaidMinutesPerPlanningPeriod(Integer minimumPaidMinutesPerPlanningPeriod)

    • maximumPaidMinutesPerPlanningPeriod

      public WorkPlan maximumPaidMinutesPerPlanningPeriod(Integer maximumPaidMinutesPerPlanningPeriod)
      Maximum paid minutes in the planning period

    • getMaximumPaidMinutesPerPlanningPeriod

      public Integer getMaximumPaidMinutesPerPlanningPeriod()

    • setMaximumPaidMinutesPerPlanningPeriod

      public void setMaximumPaidMinutesPerPlanningPeriod(Integer maximumPaidMinutesPerPlanningPeriod)

    • constrainMaximumWorkingWeekendsPerPlanningPeriod

      public WorkPlan constrainMaximumWorkingWeekendsPerPlanningPeriod(Boolean constrainMaximumWorkingWeekendsPerPlanningPeriod)
      Whether to constrain the maximum working weekends in the planning period

    • getConstrainMaximumWorkingWeekendsPerPlanningPeriod

      public Boolean getConstrainMaximumWorkingWeekendsPerPlanningPeriod()

    • setConstrainMaximumWorkingWeekendsPerPlanningPeriod

      public void setConstrainMaximumWorkingWeekendsPerPlanningPeriod(Boolean constrainMaximumWorkingWeekendsPerPlanningPeriod)

    • maximumWorkingWeekendsPerPlanningPeriod

      public WorkPlan maximumWorkingWeekendsPerPlanningPeriod(Integer maximumWorkingWeekendsPerPlanningPeriod)
      Maximum working weekends in the planning period

    • getMaximumWorkingWeekendsPerPlanningPeriod

      public Integer getMaximumWorkingWeekendsPerPlanningPeriod()

    • setMaximumWorkingWeekendsPerPlanningPeriod

      public void setMaximumWorkingWeekendsPerPlanningPeriod(Integer maximumWorkingWeekendsPerPlanningPeriod)

    • optionalDays

      public WorkPlan optionalDays(SetWrapperDayOfWeek optionalDays)
      Optional days to schedule for this work plan

    • getOptionalDays

      public SetWrapperDayOfWeek getOptionalDays()

    • setOptionalDays

      public void setOptionalDays(SetWrapperDayOfWeek optionalDays)

    • shiftStartVarianceType

      public WorkPlan shiftStartVarianceType(WorkPlan.ShiftStartVarianceTypeEnum shiftStartVarianceType)
      This constraint ensures that an agent starts each workday within a user-defined time threshold

    • getShiftStartVarianceType

      public WorkPlan.ShiftStartVarianceTypeEnum getShiftStartVarianceType()

    • setShiftStartVarianceType

      public void setShiftStartVarianceType(WorkPlan.ShiftStartVarianceTypeEnum shiftStartVarianceType)

    • shiftStartVariancePeriod

      public WorkPlan shiftStartVariancePeriod(WorkPlan.ShiftStartVariancePeriodEnum shiftStartVariancePeriod)
      The length of the period over which the maximum shift start time variance is applied

    • getShiftStartVariancePeriod

      public WorkPlan.ShiftStartVariancePeriodEnum getShiftStartVariancePeriod()

    • setShiftStartVariancePeriod

      public void setShiftStartVariancePeriod(WorkPlan.ShiftStartVariancePeriodEnum shiftStartVariancePeriod)

    • shiftStartVariances

      public WorkPlan shiftStartVariances(ListWrapperShiftStartVariance shiftStartVariances)
      Variance in minutes among start times of shifts in this work plan

    • getShiftStartVariances

      public ListWrapperShiftStartVariance getShiftStartVariances()

    • setShiftStartVariances

      public void setShiftStartVariances(ListWrapperShiftStartVariance shiftStartVariances)

    • shifts

      public WorkPlan shifts(List<WorkPlanShift> shifts)
      Shifts in this work plan

    • getShifts

      public List<WorkPlanShift> getShifts()

    • setShifts

      public void setShifts(List<WorkPlanShift> shifts)

    • agents

      public WorkPlan agents(List<DeletableUserReference> agents)
      Agents in this work plan

    • getAgents

      public List<DeletableUserReference> getAgents()

    • setAgents

      public void setAgents(List<DeletableUserReference> agents)

    • agentCount

      public WorkPlan agentCount(Integer agentCount)
      Number of agents in this work plan

    • getAgentCount

      public Integer getAgentCount()

    • setAgentCount

      public void setAgentCount(Integer agentCount)

    • metadata

      public WorkPlan metadata(WfmVersionedEntityMetadata metadata)
      Version metadata for this work plan

    • getMetadata

      public WfmVersionedEntityMetadata getMetadata()

    • setMetadata

      public void setMetadata(WfmVersionedEntityMetadata metadata)

    • getSelfUri

      public String getSelfUri()

    • 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