WorkTypeBuilder Class

Contains methods to build an instance of the lxscheduler.WorkType class.

A Builder object is obtained by invoking one of the WorkTypeBuilder methods defined by the WorkType class.

Namespace

LxScheduler

WorkTypeBuilder Methods

The following are methods for WorkTypeBuilder.

build()

Returns an instance of the lxscheduler.WorkType object.

Signature

public lxscheduler.WorkType build()

Return Value

Type: lxscheduler.WorkType

setBlockTimeAfterAppointmentInMinutes(blockTimeAfterAppointmentInMinutes)

Sets the time period, in minutes.

Signature

public lxscheduler.WorkTypeBuilder setBlockTimeAfterAppointmentInMinutes(Integer blockTimeAfterAppointmentInMinutes)

Parameters

blockTimeAfterAppointmentInMinutes
Type: Integer
The time period after the appointment is considered unavailable.

Return Value

Type: lxscheduler.WorkTypeBuilder

setBlockTimeBeforeAppointmentInMinutes(blockTimeBeforeAppointmentInMinutes)

Sets the time period, in minutes.

Signature

public lxscheduler.WorkTypeBuilder setBlockTimeBeforeAppointmentInMinutes(Integer blockTimeBeforeAppointmentInMinutes)

Parameters

blockTimeBeforeAppointmentInMinutes
Type: Integer
The time period before the appointment is considered as unavailable.

Return Value

Type: lxscheduler.WorkTypeBuilder

setDurationInMinutes(durationInMinutes)

Sets the event length.

Signature

public lxscheduler.WorkTypeBuilder setDurationInMinutes(Integer durationInMinutes)

Parameters

durationInMinutes
Type: Integer
Contains the event length, in minutes. Required if id is not given.

Return Value

Type: lxscheduler.WorkTypeBuilder

setId(id)

Sets the ID of the work type to the specified ID.

Signature

public lxscheduler.WorkTypeBuilder setId(String id)

Parameters

id
Type: String
The ID of the work type. Required if you're using shifts or if durationInMinutes is not given.

Return Value

Type: lxscheduler.WorkTypeBuilder

setOperatingHoursId(operatingHoursId)

Sets the overlap of operating hours.

Signature

public lxscheduler.WorkTypeBuilder setOperatingHoursId(String operatingHoursId)

Parameters

operatingHoursId
Type: String
The overlap of all operating hours from the account, work type, service territory, and service territory member are considered while determining time slots.

Return Value

Type: lxscheduler.WorkTypeBuilder

setSkillRequirements(skillRequirements)

Sets the skills that are required to complete a particular task for a work type.

Signature

public lxscheduler.WorkTypeBuilder setSkillRequirements(List<lxscheduler.SkillRequirement> skillRequirements)

Parameters

skillRequirements
Type: List<lxscheduler.SkillRequirement>
This method takes input as an instance of the lxscheduler.SkillRequirement class. Build the instance of the input class using the lxscheduler.SkillRequirementBuilder class.

Return Value

Type: lxscheduler.WorkTypeBuilder

setTimeFrameEndInMinutes(timeFrameEndInMinutes)

Sets the end of the timeframe.

Signature

public lxscheduler.WorkTypeBuilder setTimeFrameEndInMinutes(Integer timeFrameEndInMinutes)

Parameters

timeFrameEndInMinutes
Type: Integer

Return Value

Type: lxscheduler.WorkTypeBuilder

setTimeFrameStartInMinutes(timeFrameStartInMinutes)

Sets the beginning of the timeframe.

Signature

public lxscheduler.WorkTypeBuilder setTimeFrameStartInMinutes(Integer timeFrameStartInMinutes)

Parameters

timeFrameStartInMinutes
Type: Integer

Return Value

Type: lxscheduler.WorkTypeBuilder