Package com.mypurecloud.sdk.v2.model

Class CreateActivityPlanRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.CreateActivityPlanRequest

All Implemented Interfaces:

Serializable

public class CreateActivityPlanRequest
extends Object
implements Serializable

CreateActivityPlanRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateActivityPlanRequest.OptimizationObjectiveEnum	The optimization objective of this activity plan
static enum	CreateActivityPlanRequest.StateEnum	The state of this activity plan
static enum	CreateActivityPlanRequest.TypeEnum	The type of the activity plan

Constructor Summary

Constructors

Constructor	Description
CreateActivityPlanRequest()
CreateActivityPlanRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
CreateActivityPlanRequest	activityCodeId(String activityCodeId)	The activity code associated with the activity plan
CreateActivityPlanRequest	attendeesSearchRule(UserSearchRule attendeesSearchRule)	Attendee search rule for this activity plan
CreateActivityPlanRequest	countsAsPaidTime(Boolean countsAsPaidTime)	Whether the activity should count as paid time
CreateActivityPlanRequest	description(String description)	The description of the activity plan
boolean	equals(Object o)
CreateActivityPlanRequest	facilitated(Boolean facilitated)	Whether the sessions created by this activity plan should be facilitated
CreateActivityPlanRequest	facilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)	Facilitator search rule for this activity plan
CreateActivityPlanRequest	fixedAvailability(List<FixedAvailability> fixedAvailability)	Fixed availability configuration for the activity plan
String	getActivityCodeId()
UserSearchRule	getAttendeesSearchRule()
Boolean	getCountsAsPaidTime()
String	getDescription()
Boolean	getFacilitated()
UserSearchRule	getFacilitatorsSearchRule()
List<FixedAvailability>	getFixedAvailability()
GroupSettings	getGroupSettings()
SchedulingPeriod	getInitialSchedulePeriod()
Integer	getLengthMinutes()
List<String>	getManagementUnitIds()
String	getName()
CreateActivityPlanRequest.OptimizationObjectiveEnum	getOptimizationObjective()
RecurrenceSettings	getRecurrenceSettings()
ActivityPlanServiceGoalImpactOverrides	getServiceGoalImpactOverrides()
CreateActivityPlanRequest.StateEnum	getState()
Integer	getTransitionTimeMinutes()
CreateActivityPlanRequest.TypeEnum	getType()
CreateActivityPlanRequest	groupSettings(GroupSettings groupSettings)	Group settings for the activity plan
int	hashCode()
CreateActivityPlanRequest	initialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)	The initial scheduling period for the activity plan
CreateActivityPlanRequest	lengthMinutes(Integer lengthMinutes)	The length in minutes of the activity plan
CreateActivityPlanRequest	managementUnitIds(List<String> managementUnitIds)	The management units to which this activity plan applies.
CreateActivityPlanRequest	name(String name)	The name of the activity plan
CreateActivityPlanRequest	optimizationObjective(CreateActivityPlanRequest.OptimizationObjectiveEnum optimizationObjective)	The optimization objective of this activity plan
CreateActivityPlanRequest	recurrenceSettings(RecurrenceSettings recurrenceSettings)	Settings controlling recurrence for the activity plan.
CreateActivityPlanRequest	serviceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)	Allowable service goal impact override settings for this activity plan.
void	setActivityCodeId(String activityCodeId)
void	setAttendeesSearchRule(UserSearchRule attendeesSearchRule)
void	setCountsAsPaidTime(Boolean countsAsPaidTime)
void	setDescription(String description)
void	setFacilitated(Boolean facilitated)
void	setFacilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)
void	setFixedAvailability(List<FixedAvailability> fixedAvailability)
void	setGroupSettings(GroupSettings groupSettings)
void	setInitialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)
void	setLengthMinutes(Integer lengthMinutes)
void	setManagementUnitIds(List<String> managementUnitIds)
void	setName(String name)
void	setOptimizationObjective(CreateActivityPlanRequest.OptimizationObjectiveEnum optimizationObjective)
void	setRecurrenceSettings(RecurrenceSettings recurrenceSettings)
void	setServiceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)
void	setState(CreateActivityPlanRequest.StateEnum state)
void	setTransitionTimeMinutes(Integer transitionTimeMinutes)
void	setType(CreateActivityPlanRequest.TypeEnum type)
CreateActivityPlanRequest	state(CreateActivityPlanRequest.StateEnum state)	The state of this activity plan
String	toString()
CreateActivityPlanRequest	transitionTimeMinutes(Integer transitionTimeMinutes)	Transition time in minutes between facilitated sessions
CreateActivityPlanRequest	type(CreateActivityPlanRequest.TypeEnum type)	The type of the activity plan

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CreateActivityPlanRequest

public CreateActivityPlanRequest()

CreateActivityPlanRequest

public CreateActivityPlanRequest(Boolean initWithEmptyList)

Method Details

name

public CreateActivityPlanRequest name(String name)

The name of the activity plan

getName

public String getName()

setName

public void setName(String name)

managementUnitIds

public CreateActivityPlanRequest managementUnitIds(List<String> managementUnitIds)

The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit

getManagementUnitIds

public List<String> getManagementUnitIds()

setManagementUnitIds

public void setManagementUnitIds(List<String> managementUnitIds)

description

public CreateActivityPlanRequest description(String description)

The description of the activity plan

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

activityCodeId

public CreateActivityPlanRequest activityCodeId(String activityCodeId)

The activity code associated with the activity plan

getActivityCodeId

public String getActivityCodeId()

setActivityCodeId

public void setActivityCodeId(String activityCodeId)

type

public CreateActivityPlanRequest type(CreateActivityPlanRequest.TypeEnum type)

The type of the activity plan

getType

public CreateActivityPlanRequest.TypeEnum getType()

setType

public void setType(CreateActivityPlanRequest.TypeEnum type)

lengthMinutes

public CreateActivityPlanRequest lengthMinutes(Integer lengthMinutes)

The length in minutes of the activity plan

getLengthMinutes

public Integer getLengthMinutes()

setLengthMinutes

public void setLengthMinutes(Integer lengthMinutes)

initialSchedulePeriod

public CreateActivityPlanRequest initialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)

The initial scheduling period for the activity plan

getInitialSchedulePeriod

public SchedulingPeriod getInitialSchedulePeriod()

setInitialSchedulePeriod

public void setInitialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)

groupSettings

public CreateActivityPlanRequest groupSettings(GroupSettings groupSettings)

Group settings for the activity plan

getGroupSettings

public GroupSettings getGroupSettings()

setGroupSettings

public void setGroupSettings(GroupSettings groupSettings)

recurrenceSettings

public CreateActivityPlanRequest recurrenceSettings(RecurrenceSettings recurrenceSettings)

Settings controlling recurrence for the activity plan. If not set the activity plan will only occur once

getRecurrenceSettings

public RecurrenceSettings getRecurrenceSettings()

setRecurrenceSettings

public void setRecurrenceSettings(RecurrenceSettings recurrenceSettings)

attendeesSearchRule

public CreateActivityPlanRequest attendeesSearchRule(UserSearchRule attendeesSearchRule)

Attendee search rule for this activity plan

getAttendeesSearchRule

public UserSearchRule getAttendeesSearchRule()

setAttendeesSearchRule

public void setAttendeesSearchRule(UserSearchRule attendeesSearchRule)

facilitated

public CreateActivityPlanRequest facilitated(Boolean facilitated)

Whether the sessions created by this activity plan should be facilitated

getFacilitated

public Boolean getFacilitated()

setFacilitated

public void setFacilitated(Boolean facilitated)

facilitatorsSearchRule

public CreateActivityPlanRequest facilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)

Facilitator search rule for this activity plan

getFacilitatorsSearchRule

public UserSearchRule getFacilitatorsSearchRule()

setFacilitatorsSearchRule

public void setFacilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)

transitionTimeMinutes

public CreateActivityPlanRequest transitionTimeMinutes(Integer transitionTimeMinutes)

Transition time in minutes between facilitated sessions

getTransitionTimeMinutes

public Integer getTransitionTimeMinutes()

setTransitionTimeMinutes

public void setTransitionTimeMinutes(Integer transitionTimeMinutes)

serviceGoalImpactOverrides

public CreateActivityPlanRequest serviceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)

Allowable service goal impact override settings for this activity plan. If not set the business unit setting will be used

getServiceGoalImpactOverrides

public ActivityPlanServiceGoalImpactOverrides getServiceGoalImpactOverrides()

setServiceGoalImpactOverrides

public void setServiceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)

optimizationObjective

public CreateActivityPlanRequest optimizationObjective(CreateActivityPlanRequest.OptimizationObjectiveEnum optimizationObjective)

The optimization objective of this activity plan

getOptimizationObjective

public CreateActivityPlanRequest.OptimizationObjectiveEnum getOptimizationObjective()

setOptimizationObjective

public void setOptimizationObjective(CreateActivityPlanRequest.OptimizationObjectiveEnum optimizationObjective)

state

public CreateActivityPlanRequest state(CreateActivityPlanRequest.StateEnum state)

The state of this activity plan

getState

public CreateActivityPlanRequest.StateEnum getState()

setState

public void setState(CreateActivityPlanRequest.StateEnum state)

countsAsPaidTime

public CreateActivityPlanRequest countsAsPaidTime(Boolean countsAsPaidTime)

Whether the activity should count as paid time

getCountsAsPaidTime

public Boolean getCountsAsPaidTime()

setCountsAsPaidTime

public void setCountsAsPaidTime(Boolean countsAsPaidTime)

fixedAvailability

public CreateActivityPlanRequest fixedAvailability(List<FixedAvailability> fixedAvailability)

Fixed availability configuration for the activity plan

getFixedAvailability

public List<FixedAvailability> getFixedAvailability()

setFixedAvailability

public void setFixedAvailability(List<FixedAvailability> fixedAvailability)

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