Package com.mypurecloud.sdk.v2.model

Class ActivityPlanResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.ActivityPlanResponse

All Implemented Interfaces:

Serializable

public class ActivityPlanResponse
extends Object
implements Serializable

ActivityPlanResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ActivityPlanResponse()
ActivityPlanResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ActivityPlanResponse	activityCode(ActivityCodeReference activityCode)	The activity code associated with this activity plan.
ActivityPlanResponse	attendeesSearchRule(UserSearchRule attendeesSearchRule)	Attendee search rule for this activity plan
ActivityPlanResponse	countsAsPaidTime(Boolean countsAsPaidTime)	Whether the activity should count as paid time
ActivityPlanResponse	createdBy(UserReference createdBy)	The user who created this activity plan
ActivityPlanResponse	createdDate(Date createdDate)	The date the activity plan was created, in ISO-8601 format
ActivityPlanResponse	description(String description)	The description of this activity plan
boolean	equals(Object o)
ActivityPlanResponse	facilitated(Boolean facilitated)	Whether the sessions created by this activity plan should be facilitated
ActivityPlanResponse	facilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)	Facilitator search rule for this activity plan
ActivityPlanResponse	fixedAvailability(List<FixedAvailability> fixedAvailability)	Fixed availability configuration for this activity plan
ActivityCodeReference	getActivityCode()
UserSearchRule	getAttendeesSearchRule()
Boolean	getCountsAsPaidTime()
UserReference	getCreatedBy()
Date	getCreatedDate()
String	getDescription()
Boolean	getFacilitated()
UserSearchRule	getFacilitatorsSearchRule()
List<FixedAvailability>	getFixedAvailability()
GroupSettings	getGroupSettings()
String	getId()
SchedulingPeriod	getInitialSchedulePeriod()
UserReference	getLastRunBy()
Date	getLastRunDate()
Integer	getLengthMinutes()
List<ManagementUnitReference>	getManagementUnits()
UserReference	getModifiedBy()
Date	getModifiedDate()
String	getName()
ActivityPlanResponse.OptimizationObjectiveEnum	getOptimizationObjective()
RecurrenceSettings	getRecurrenceSettings()
String	getSelfUri()
ActivityPlanServiceGoalImpactOverrides	getServiceGoalImpactOverrides()
ActivityPlanResponse.StateEnum	getState()
Integer	getTransitionTimeMinutes()
ActivityPlanResponse.TypeEnum	getType()
ActivityPlanResponse	groupSettings(GroupSettings groupSettings)	Group settings for this activity plan
int	hashCode()
ActivityPlanResponse	id(String id)	The globally unique identifier for the object.
ActivityPlanResponse	initialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)	The initial schedule period of the activity plan
ActivityPlanResponse	lastRunBy(UserReference lastRunBy)	The last user to run this activity plan
ActivityPlanResponse	lastRunDate(Date lastRunDate)	The date on which the activity plan was last manually run, in ISO-8601 format
ActivityPlanResponse	lengthMinutes(Integer lengthMinutes)	The length of the activity in minutes
ActivityPlanResponse	managementUnits(List<ManagementUnitReference> managementUnits)	The management units to which this activity plan applies.
ActivityPlanResponse	modifiedBy(UserReference modifiedBy)	The last user to modify this activity plan.
ActivityPlanResponse	modifiedDate(Date modifiedDate)	The date the activity plan was modified, in ISO-8601 format
ActivityPlanResponse	name(String name)	The name of the activity plan
ActivityPlanResponse	optimizationObjective(ActivityPlanResponse.OptimizationObjectiveEnum optimizationObjective)	The optimization objective of this activity plan
ActivityPlanResponse	recurrenceSettings(RecurrenceSettings recurrenceSettings)	Recurrence settings for this activity plan
ActivityPlanResponse	serviceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)	Allowable service goal impact override settings for this activity plan
void	setActivityCode(ActivityCodeReference activityCode)
void	setAttendeesSearchRule(UserSearchRule attendeesSearchRule)
void	setCountsAsPaidTime(Boolean countsAsPaidTime)
void	setCreatedBy(UserReference createdBy)
void	setCreatedDate(Date createdDate)
void	setDescription(String description)
void	setFacilitated(Boolean facilitated)
void	setFacilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)
void	setFixedAvailability(List<FixedAvailability> fixedAvailability)
void	setGroupSettings(GroupSettings groupSettings)
void	setId(String id)
void	setInitialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)
void	setLastRunBy(UserReference lastRunBy)
void	setLastRunDate(Date lastRunDate)
void	setLengthMinutes(Integer lengthMinutes)
void	setManagementUnits(List<ManagementUnitReference> managementUnits)
void	setModifiedBy(UserReference modifiedBy)
void	setModifiedDate(Date modifiedDate)
void	setName(String name)
void	setOptimizationObjective(ActivityPlanResponse.OptimizationObjectiveEnum optimizationObjective)
void	setRecurrenceSettings(RecurrenceSettings recurrenceSettings)
void	setServiceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)
void	setState(ActivityPlanResponse.StateEnum state)
void	setTransitionTimeMinutes(Integer transitionTimeMinutes)
void	setType(ActivityPlanResponse.TypeEnum type)
ActivityPlanResponse	state(ActivityPlanResponse.StateEnum state)	The state of this activity plan
String	toString()
ActivityPlanResponse	transitionTimeMinutes(Integer transitionTimeMinutes)	Transition time in minutes between facilitated sessions
ActivityPlanResponse	type(ActivityPlanResponse.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

ActivityPlanResponse

public ActivityPlanResponse()

ActivityPlanResponse

public ActivityPlanResponse(Boolean initWithEmptyList)

Method Details

id

public ActivityPlanResponse id(String id)

The globally unique identifier for the object.

getId

public String getId()

setId

public void setId(String id)

name

public ActivityPlanResponse name(String name)

The name of the activity plan

getName

public String getName()

setName

public void setName(String name)

managementUnits

public ActivityPlanResponse managementUnits(List<ManagementUnitReference> managementUnits)

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

getManagementUnits

public List<ManagementUnitReference> getManagementUnits()

setManagementUnits

public void setManagementUnits(List<ManagementUnitReference> managementUnits)

description

public ActivityPlanResponse description(String description)

The description of this activity plan

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

activityCode

public ActivityPlanResponse activityCode(ActivityCodeReference activityCode)

The activity code associated with this activity plan. It is recommended to load and cache the entire list of activity codes rather than look up individual codes

getActivityCode

public ActivityCodeReference getActivityCode()

setActivityCode

public void setActivityCode(ActivityCodeReference activityCode)

type

public ActivityPlanResponse type(ActivityPlanResponse.TypeEnum type)

The type of the activity plan

getType

public ActivityPlanResponse.TypeEnum getType()

setType

public void setType(ActivityPlanResponse.TypeEnum type)

initialSchedulePeriod

public ActivityPlanResponse initialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)

The initial schedule period of the activity plan

getInitialSchedulePeriod

public SchedulingPeriod getInitialSchedulePeriod()

setInitialSchedulePeriod

public void setInitialSchedulePeriod(SchedulingPeriod initialSchedulePeriod)

lengthMinutes

public ActivityPlanResponse lengthMinutes(Integer lengthMinutes)

The length of the activity in minutes

getLengthMinutes

public Integer getLengthMinutes()

setLengthMinutes

public void setLengthMinutes(Integer lengthMinutes)

groupSettings

public ActivityPlanResponse groupSettings(GroupSettings groupSettings)

Group settings for this activity plan

getGroupSettings

public GroupSettings getGroupSettings()

setGroupSettings

public void setGroupSettings(GroupSettings groupSettings)

recurrenceSettings

public ActivityPlanResponse recurrenceSettings(RecurrenceSettings recurrenceSettings)

Recurrence settings for this activity plan

getRecurrenceSettings

public RecurrenceSettings getRecurrenceSettings()

setRecurrenceSettings

public void setRecurrenceSettings(RecurrenceSettings recurrenceSettings)

attendeesSearchRule

public ActivityPlanResponse attendeesSearchRule(UserSearchRule attendeesSearchRule)

Attendee search rule for this activity plan

getAttendeesSearchRule

public UserSearchRule getAttendeesSearchRule()

setAttendeesSearchRule

public void setAttendeesSearchRule(UserSearchRule attendeesSearchRule)

facilitated

public ActivityPlanResponse 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 ActivityPlanResponse facilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)

Facilitator search rule for this activity plan

getFacilitatorsSearchRule

public UserSearchRule getFacilitatorsSearchRule()

setFacilitatorsSearchRule

public void setFacilitatorsSearchRule(UserSearchRule facilitatorsSearchRule)

transitionTimeMinutes

public ActivityPlanResponse transitionTimeMinutes(Integer transitionTimeMinutes)

Transition time in minutes between facilitated sessions

getTransitionTimeMinutes

public Integer getTransitionTimeMinutes()

setTransitionTimeMinutes

public void setTransitionTimeMinutes(Integer transitionTimeMinutes)

serviceGoalImpactOverrides

public ActivityPlanResponse serviceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)

Allowable service goal impact override settings for this activity plan

getServiceGoalImpactOverrides

public ActivityPlanServiceGoalImpactOverrides getServiceGoalImpactOverrides()

setServiceGoalImpactOverrides

public void setServiceGoalImpactOverrides(ActivityPlanServiceGoalImpactOverrides serviceGoalImpactOverrides)

optimizationObjective

public ActivityPlanResponse optimizationObjective(ActivityPlanResponse.OptimizationObjectiveEnum optimizationObjective)

The optimization objective of this activity plan

getOptimizationObjective

public ActivityPlanResponse.OptimizationObjectiveEnum getOptimizationObjective()

setOptimizationObjective

public void setOptimizationObjective(ActivityPlanResponse.OptimizationObjectiveEnum optimizationObjective)

fixedAvailability

public ActivityPlanResponse fixedAvailability(List<FixedAvailability> fixedAvailability)

Fixed availability configuration for this activity plan

getFixedAvailability

public List<FixedAvailability> getFixedAvailability()

setFixedAvailability

public void setFixedAvailability(List<FixedAvailability> fixedAvailability)

state

public ActivityPlanResponse state(ActivityPlanResponse.StateEnum state)

The state of this activity plan

getState

public ActivityPlanResponse.StateEnum getState()

setState

public void setState(ActivityPlanResponse.StateEnum state)

countsAsPaidTime

public ActivityPlanResponse countsAsPaidTime(Boolean countsAsPaidTime)

Whether the activity should count as paid time

getCountsAsPaidTime

public Boolean getCountsAsPaidTime()

setCountsAsPaidTime

public void setCountsAsPaidTime(Boolean countsAsPaidTime)

createdDate

public ActivityPlanResponse createdDate(Date createdDate)

The date the activity plan was created, in ISO-8601 format

getCreatedDate

public Date getCreatedDate()

setCreatedDate

public void setCreatedDate(Date createdDate)

createdBy

public ActivityPlanResponse createdBy(UserReference createdBy)

The user who created this activity plan

getCreatedBy

public UserReference getCreatedBy()

setCreatedBy

public void setCreatedBy(UserReference createdBy)

modifiedDate

public ActivityPlanResponse modifiedDate(Date modifiedDate)

The date the activity plan was modified, in ISO-8601 format

getModifiedDate

public Date getModifiedDate()

setModifiedDate

public void setModifiedDate(Date modifiedDate)

modifiedBy

public ActivityPlanResponse modifiedBy(UserReference modifiedBy)

The last user to modify this activity plan. The id may be 'System' if it was an automated process

getModifiedBy

public UserReference getModifiedBy()

setModifiedBy

public void setModifiedBy(UserReference modifiedBy)

lastRunDate

public ActivityPlanResponse lastRunDate(Date lastRunDate)

The date on which the activity plan was last manually run, in ISO-8601 format

getLastRunDate

public Date getLastRunDate()

setLastRunDate

public void setLastRunDate(Date lastRunDate)

lastRunBy

public ActivityPlanResponse lastRunBy(UserReference lastRunBy)

The last user to run this activity plan

getLastRunBy

public UserReference getLastRunBy()

setLastRunBy

public void setLastRunBy(UserReference lastRunBy)

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