Package com.mypurecloud.sdk.v2.model

Class ActivityPlanListItem

java.lang.Object

com.mypurecloud.sdk.v2.model.ActivityPlanListItem

All Implemented Interfaces:

Serializable

public class ActivityPlanListItem
extends Object
implements Serializable

ActivityPlanListItem

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ActivityPlanListItem()
ActivityPlanListItem(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ActivityPlanListItem	activityCode(ActivityCodeReference activityCode)	The activity code to which this activity plan applies.
ActivityPlanListItem	createdBy(UserReference createdBy)	The user who created this activity plan
ActivityPlanListItem	createdDate(Date createdDate)	The date the activity plan was created, in ISO-8601 format
ActivityPlanListItem	description(String description)	The description of this activity plan
boolean	equals(Object o)
ActivityCodeReference	getActivityCode()
UserReference	getCreatedBy()
Date	getCreatedDate()
String	getDescription()
String	getId()
UserReference	getLastRunBy()
Date	getLastRunDate()
List<ManagementUnitReference>	getManagementUnits()
UserReference	getModifiedBy()
Date	getModifiedDate()
String	getName()
ActivityPlanListItem.OptimizationObjectiveEnum	getOptimizationObjective()
RecurrenceSettings	getRecurrenceSettings()
String	getSelfUri()
ActivityPlanListItem.StateEnum	getState()
ActivityPlanListItem.TypeEnum	getType()
int	hashCode()
ActivityPlanListItem	id(String id)	The globally unique identifier for the object.
ActivityPlanListItem	lastRunBy(UserReference lastRunBy)	The last user to run this activity plan
ActivityPlanListItem	lastRunDate(Date lastRunDate)	The date on which the activity plan was last manually run, in ISO-8601 format
ActivityPlanListItem	managementUnits(List<ManagementUnitReference> managementUnits)	The management units to which this activity plan applies.
ActivityPlanListItem	modifiedBy(UserReference modifiedBy)	The last user to modify this activity plan.
ActivityPlanListItem	modifiedDate(Date modifiedDate)	The date the activity plan was modified, in ISO-8601 format
ActivityPlanListItem	name(String name)	The name of the activity plan
ActivityPlanListItem	optimizationObjective(ActivityPlanListItem.OptimizationObjectiveEnum optimizationObjective)	The optimization objective of this activity plan
ActivityPlanListItem	recurrenceSettings(RecurrenceSettings recurrenceSettings)	Recurrence settings for this activity plan
void	setActivityCode(ActivityCodeReference activityCode)
void	setCreatedBy(UserReference createdBy)
void	setCreatedDate(Date createdDate)
void	setDescription(String description)
void	setId(String id)
void	setLastRunBy(UserReference lastRunBy)
void	setLastRunDate(Date lastRunDate)
void	setManagementUnits(List<ManagementUnitReference> managementUnits)
void	setModifiedBy(UserReference modifiedBy)
void	setModifiedDate(Date modifiedDate)
void	setName(String name)
void	setOptimizationObjective(ActivityPlanListItem.OptimizationObjectiveEnum optimizationObjective)
void	setRecurrenceSettings(RecurrenceSettings recurrenceSettings)
void	setState(ActivityPlanListItem.StateEnum state)
void	setType(ActivityPlanListItem.TypeEnum type)
ActivityPlanListItem	state(ActivityPlanListItem.StateEnum state)	The state of this activity plan
String	toString()
ActivityPlanListItem	type(ActivityPlanListItem.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

ActivityPlanListItem

public ActivityPlanListItem()

ActivityPlanListItem

public ActivityPlanListItem(Boolean initWithEmptyList)

Method Details

id

public ActivityPlanListItem id(String id)

The globally unique identifier for the object.

getId

public String getId()

setId

public void setId(String id)

name

public ActivityPlanListItem name(String name)

The name of the activity plan

getName

public String getName()

setName

public void setName(String name)

managementUnits

public ActivityPlanListItem managementUnits(List<ManagementUnitReference> managementUnits)

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

getManagementUnits

public List<ManagementUnitReference> getManagementUnits()

setManagementUnits

public void setManagementUnits(List<ManagementUnitReference> managementUnits)

description

public ActivityPlanListItem description(String description)

The description of this activity plan

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

activityCode

public ActivityPlanListItem activityCode(ActivityCodeReference activityCode)

The activity code to which this activity plan applies. Note: 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 ActivityPlanListItem type(ActivityPlanListItem.TypeEnum type)

The type of the activity plan

getType

public ActivityPlanListItem.TypeEnum getType()

setType

public void setType(ActivityPlanListItem.TypeEnum type)

optimizationObjective

public ActivityPlanListItem optimizationObjective(ActivityPlanListItem.OptimizationObjectiveEnum optimizationObjective)

The optimization objective of this activity plan

getOptimizationObjective

public ActivityPlanListItem.OptimizationObjectiveEnum getOptimizationObjective()

setOptimizationObjective

public void setOptimizationObjective(ActivityPlanListItem.OptimizationObjectiveEnum optimizationObjective)

recurrenceSettings

public ActivityPlanListItem recurrenceSettings(RecurrenceSettings recurrenceSettings)

Recurrence settings for this activity plan

getRecurrenceSettings

public RecurrenceSettings getRecurrenceSettings()

setRecurrenceSettings

public void setRecurrenceSettings(RecurrenceSettings recurrenceSettings)

state

public ActivityPlanListItem state(ActivityPlanListItem.StateEnum state)

The state of this activity plan

getState

public ActivityPlanListItem.StateEnum getState()

setState

public void setState(ActivityPlanListItem.StateEnum state)

lastRunDate

public ActivityPlanListItem 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 ActivityPlanListItem lastRunBy(UserReference lastRunBy)

The last user to run this activity plan

getLastRunBy

public UserReference getLastRunBy()

setLastRunBy

public void setLastRunBy(UserReference lastRunBy)

createdDate

public ActivityPlanListItem 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 ActivityPlanListItem createdBy(UserReference createdBy)

The user who created this activity plan

getCreatedBy

public UserReference getCreatedBy()

setCreatedBy

public void setCreatedBy(UserReference createdBy)

modifiedDate

public ActivityPlanListItem 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 ActivityPlanListItem 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)

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