Package com.mypurecloud.sdk.v2.model

Class WorkitemVersion

java.lang.Object

com.mypurecloud.sdk.v2.model.WorkitemVersion

All Implemented Interfaces:

Serializable

public class WorkitemVersion
extends Object
implements Serializable

WorkitemVersion

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkitemVersion.AssignmentStateEnum	The assignment state of the workitem.
static enum	WorkitemVersion.StatusCategoryEnum	The Category of the current Status of the Workitem.

Constructor Summary

Constructors

Constructor	Description
WorkitemVersion()
WorkitemVersion(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
WorkitemVersion	alertTimeoutSeconds(Integer alertTimeoutSeconds)	The duration in seconds before an alert will timeout.
WorkitemVersion	assignee(UserReferenceWithName assignee)	The assignee of the Workitem.
WorkitemVersion	assignmentState(WorkitemVersion.AssignmentStateEnum assignmentState)	The assignment state of the workitem.
WorkitemVersion	autoStatusTransition(Boolean autoStatusTransition)	Set it to false to disable auto status transition.
WorkitemVersion	autoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)	Auto status transition details of Workitem.
WorkitemVersion	customFields(Map<String,Object> customFields)	Custom fields defined in the schema referenced by the Workitem.
WorkitemVersion	dateAssignmentStateChanged(Date dateAssignmentStateChanged)	The assignment state change date.
WorkitemVersion	dateClosed(Date dateClosed)	The date the Workitem was closed.
WorkitemVersion	dateCreated(Date dateCreated)	The creation date of the Workitem.
WorkitemVersion	dateDue(Date dateDue)	The due date of the Workitem.
WorkitemVersion	dateExpires(Date dateExpires)	The expiry date of the Workitem.
WorkitemVersion	dateModified(Date dateModified)	The modified date of the Workitem.
WorkitemVersion	dateStatusChanged(Date dateStatusChanged)	The State change date.
WorkitemVersion	description(String description)	The description of the Workitem.
WorkitemVersion	division(Division division)	The division to which this entity belongs.
WorkitemVersion	durationSeconds(Integer durationSeconds)	The estimated duration in seconds to complete the workitem.
boolean	equals(Object o)
WorkitemVersion	externalContact(ExternalContactReference externalContact)	The external contact of the Workitem.
WorkitemVersion	externalTag(String externalTag)	The external tag of the Workitem.
Integer	getAlertTimeoutSeconds()
UserReferenceWithName	getAssignee()
WorkitemVersion.AssignmentStateEnum	getAssignmentState()
Boolean	getAutoStatusTransition()
AutoStatusTransitionDetail	getAutoStatusTransitionDetail()
Map<String,Object>	getCustomFields()
Date	getDateAssignmentStateChanged()
Date	getDateClosed()
Date	getDateCreated()
Date	getDateDue()
Date	getDateExpires()
Date	getDateModified()
Date	getDateStatusChanged()
String	getDescription()
Division	getDivision()
Integer	getDurationSeconds()
ExternalContactReference	getExternalContact()
String	getExternalTag()
String	getId()
LanguageReference	getLanguage()
UserReference	getModifiedBy()
String	getName()
List<UserReference>	getPreferredAgents()
Integer	getPriority()
WorkitemQueueReference	getQueue()
UserReferenceWithName	getReporter()
WorkitemSchema	getSchema()
List<WorkitemScoredAgent>	getScoredAgents()
WorkitemScriptReference	getScript()
String	getSelfUri()
List<RoutingSkillReference>	getSkills()
WorkitemStatusReference	getStatus()
WorkitemVersion.StatusCategoryEnum	getStatusCategory()
Integer	getTtl()
WorktypeReference	getType()
WorkitemUtilizationLabelReference	getUtilizationLabel()
Integer	getVersion()
WorkbinReference	getWorkbin()
int	hashCode()
WorkitemVersion	language(LanguageReference language)	The language of the Workitem.
WorkitemVersion	modifiedBy(UserReference modifiedBy)	The User who modified the Workitem.
WorkitemVersion	name(String name)	The name of the Workitem.
WorkitemVersion	preferredAgents(List<UserReference> preferredAgents)	The preferred agents of the Workitem.
WorkitemVersion	priority(Integer priority)	The priority of the Workitem.
WorkitemVersion	queue(WorkitemQueueReference queue)	The Workitems queue.
WorkitemVersion	reporter(UserReferenceWithName reporter)	The reporter of the Workitem.
WorkitemVersion	schema(WorkitemSchema schema)	The schema defining the custom fields of the Workitem.
WorkitemVersion	scoredAgents(List<WorkitemScoredAgent> scoredAgents)	A list of scored agents for the Workitem.
WorkitemVersion	script(WorkitemScriptReference script)	The script that will be executed for the Workitem.
void	setAlertTimeoutSeconds(Integer alertTimeoutSeconds)
void	setAssignee(UserReferenceWithName assignee)
void	setAssignmentState(WorkitemVersion.AssignmentStateEnum assignmentState)
void	setAutoStatusTransition(Boolean autoStatusTransition)
void	setAutoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)
void	setCustomFields(Map<String,Object> customFields)
void	setDateAssignmentStateChanged(Date dateAssignmentStateChanged)
void	setDateClosed(Date dateClosed)
void	setDateCreated(Date dateCreated)
void	setDateDue(Date dateDue)
void	setDateExpires(Date dateExpires)
void	setDateModified(Date dateModified)
void	setDateStatusChanged(Date dateStatusChanged)
void	setDescription(String description)
void	setDivision(Division division)
void	setDurationSeconds(Integer durationSeconds)
void	setExternalContact(ExternalContactReference externalContact)
void	setExternalTag(String externalTag)
void	setLanguage(LanguageReference language)
void	setModifiedBy(UserReference modifiedBy)
void	setName(String name)
void	setPreferredAgents(List<UserReference> preferredAgents)
void	setPriority(Integer priority)
void	setQueue(WorkitemQueueReference queue)
void	setReporter(UserReferenceWithName reporter)
void	setSchema(WorkitemSchema schema)
void	setScoredAgents(List<WorkitemScoredAgent> scoredAgents)
void	setScript(WorkitemScriptReference script)
void	setSkills(List<RoutingSkillReference> skills)
void	setStatus(WorkitemStatusReference status)
void	setStatusCategory(WorkitemVersion.StatusCategoryEnum statusCategory)
void	setTtl(Integer ttl)
void	setType(WorktypeReference type)
void	setUtilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)
void	setVersion(Integer version)
void	setWorkbin(WorkbinReference workbin)
WorkitemVersion	skills(List<RoutingSkillReference> skills)	The skills of the Workitem.
WorkitemVersion	status(WorkitemStatusReference status)	The current Status of the Workitem.
WorkitemVersion	statusCategory(WorkitemVersion.StatusCategoryEnum statusCategory)	The Category of the current Status of the Workitem.
String	toString()
WorkitemVersion	ttl(Integer ttl)	The time to live of the Workitem in seconds.
WorkitemVersion	type(WorktypeReference type)	The Worktype of the Workitem.
WorkitemVersion	utilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)	The utilization label of the Workitem.
WorkitemVersion	version(Integer version)	Version
WorkitemVersion	workbin(WorkbinReference workbin)	The Workbin that contains the Workitem.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkitemVersion

public WorkitemVersion()

WorkitemVersion

public WorkitemVersion(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public WorkitemVersion name(String name)

The name of the Workitem.

getName

public String getName()

setName

public void setName(String name)

division

public WorkitemVersion division(Division division)

The division to which this entity belongs.

getDivision

public Division getDivision()

setDivision

public void setDivision(Division division)

type

public WorkitemVersion type(WorktypeReference type)

The Worktype of the Workitem.

getType

public WorktypeReference getType()

setType

public void setType(WorktypeReference type)

description

public WorkitemVersion description(String description)

The description of the Workitem.

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

language

public WorkitemVersion language(LanguageReference language)

The language of the Workitem.

getLanguage

public LanguageReference getLanguage()

setLanguage

public void setLanguage(LanguageReference language)

utilizationLabel

public WorkitemVersion utilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)

The utilization label of the Workitem.

getUtilizationLabel

public WorkitemUtilizationLabelReference getUtilizationLabel()

setUtilizationLabel

public void setUtilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)

priority

public WorkitemVersion priority(Integer priority)

The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000.

getPriority

public Integer getPriority()

setPriority

public void setPriority(Integer priority)

dateCreated

public WorkitemVersion dateCreated(Date dateCreated)

The creation date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

dateModified

public WorkitemVersion dateModified(Date dateModified)

The modified date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateModified

public Date getDateModified()

setDateModified

public void setDateModified(Date dateModified)

dateDue

public WorkitemVersion dateDue(Date dateDue)

The due date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateDue

public Date getDateDue()

setDateDue

public void setDateDue(Date dateDue)

dateExpires

public WorkitemVersion dateExpires(Date dateExpires)

The expiry date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateExpires

public Date getDateExpires()

setDateExpires

public void setDateExpires(Date dateExpires)

durationSeconds

public WorkitemVersion durationSeconds(Integer durationSeconds)

The estimated duration in seconds to complete the workitem.

getDurationSeconds

public Integer getDurationSeconds()

setDurationSeconds

public void setDurationSeconds(Integer durationSeconds)

ttl

public WorkitemVersion ttl(Integer ttl)

The time to live of the Workitem in seconds.

getTtl

public Integer getTtl()

setTtl

public void setTtl(Integer ttl)

status

public WorkitemVersion status(WorkitemStatusReference status)

The current Status of the Workitem.

getStatus

public WorkitemStatusReference getStatus()

setStatus

public void setStatus(WorkitemStatusReference status)

statusCategory

public WorkitemVersion statusCategory(WorkitemVersion.StatusCategoryEnum statusCategory)

The Category of the current Status of the Workitem.

getStatusCategory

public WorkitemVersion.StatusCategoryEnum getStatusCategory()

setStatusCategory

public void setStatusCategory(WorkitemVersion.StatusCategoryEnum statusCategory)

dateStatusChanged

public WorkitemVersion dateStatusChanged(Date dateStatusChanged)

The State change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateStatusChanged

public Date getDateStatusChanged()

setDateStatusChanged

public void setDateStatusChanged(Date dateStatusChanged)

dateClosed

public WorkitemVersion dateClosed(Date dateClosed)

The date the Workitem was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateClosed

public Date getDateClosed()

setDateClosed

public void setDateClosed(Date dateClosed)

workbin

public WorkitemVersion workbin(WorkbinReference workbin)

The Workbin that contains the Workitem.

getWorkbin

public WorkbinReference getWorkbin()

setWorkbin

public void setWorkbin(WorkbinReference workbin)

reporter

public WorkitemVersion reporter(UserReferenceWithName reporter)

The reporter of the Workitem.

getReporter

public UserReferenceWithName getReporter()

setReporter

public void setReporter(UserReferenceWithName reporter)

assignee

public WorkitemVersion assignee(UserReferenceWithName assignee)

The assignee of the Workitem.

getAssignee

public UserReferenceWithName getAssignee()

setAssignee

public void setAssignee(UserReferenceWithName assignee)

externalContact

public WorkitemVersion externalContact(ExternalContactReference externalContact)

The external contact of the Workitem.

getExternalContact

public ExternalContactReference getExternalContact()

setExternalContact

public void setExternalContact(ExternalContactReference externalContact)

externalTag

public WorkitemVersion externalTag(String externalTag)

The external tag of the Workitem.

getExternalTag

public String getExternalTag()

setExternalTag

public void setExternalTag(String externalTag)

modifiedBy

public WorkitemVersion modifiedBy(UserReference modifiedBy)

The User who modified the Workitem.

getModifiedBy

public UserReference getModifiedBy()

setModifiedBy

public void setModifiedBy(UserReference modifiedBy)

queue

public WorkitemVersion queue(WorkitemQueueReference queue)

The Workitems queue.

getQueue

public WorkitemQueueReference getQueue()

setQueue

public void setQueue(WorkitemQueueReference queue)

assignmentState

public WorkitemVersion assignmentState(WorkitemVersion.AssignmentStateEnum assignmentState)

The assignment state of the workitem.

getAssignmentState

public WorkitemVersion.AssignmentStateEnum getAssignmentState()

setAssignmentState

public void setAssignmentState(WorkitemVersion.AssignmentStateEnum assignmentState)

dateAssignmentStateChanged

public WorkitemVersion dateAssignmentStateChanged(Date dateAssignmentStateChanged)

The assignment state change date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateAssignmentStateChanged

public Date getDateAssignmentStateChanged()

setDateAssignmentStateChanged

public void setDateAssignmentStateChanged(Date dateAssignmentStateChanged)

alertTimeoutSeconds

public WorkitemVersion alertTimeoutSeconds(Integer alertTimeoutSeconds)

The duration in seconds before an alert will timeout.

getAlertTimeoutSeconds

public Integer getAlertTimeoutSeconds()

setAlertTimeoutSeconds

public void setAlertTimeoutSeconds(Integer alertTimeoutSeconds)

skills

public WorkitemVersion skills(List<RoutingSkillReference> skills)

The skills of the Workitem.

getSkills

public List<RoutingSkillReference> getSkills()

setSkills

public void setSkills(List<RoutingSkillReference> skills)

preferredAgents

public WorkitemVersion preferredAgents(List<UserReference> preferredAgents)

The preferred agents of the Workitem.

getPreferredAgents

public List<UserReference> getPreferredAgents()

setPreferredAgents

public void setPreferredAgents(List<UserReference> preferredAgents)

autoStatusTransition

public WorkitemVersion autoStatusTransition(Boolean autoStatusTransition)

Set it to false to disable auto status transition. By default, it is enabled.

getAutoStatusTransition

public Boolean getAutoStatusTransition()

setAutoStatusTransition

public void setAutoStatusTransition(Boolean autoStatusTransition)

schema

public WorkitemVersion schema(WorkitemSchema schema)

The schema defining the custom fields of the Workitem. The schema is inherited from the Workitems Worktype at creation time.

getSchema

public WorkitemSchema getSchema()

setSchema

public void setSchema(WorkitemSchema schema)

customFields

public WorkitemVersion customFields(Map<String,Object> customFields)

Custom fields defined in the schema referenced by the Workitem.

getCustomFields

public Map<String,Object> getCustomFields()

setCustomFields

public void setCustomFields(Map<String,Object> customFields)

autoStatusTransitionDetail

public WorkitemVersion autoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)

Auto status transition details of Workitem.

getAutoStatusTransitionDetail

public AutoStatusTransitionDetail getAutoStatusTransitionDetail()

setAutoStatusTransitionDetail

public void setAutoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)

scoredAgents

public WorkitemVersion scoredAgents(List<WorkitemScoredAgent> scoredAgents)

A list of scored agents for the Workitem.

getScoredAgents

public List<WorkitemScoredAgent> getScoredAgents()

setScoredAgents

public void setScoredAgents(List<WorkitemScoredAgent> scoredAgents)

script

public WorkitemVersion script(WorkitemScriptReference script)

The script that will be executed for the Workitem.

getScript

public WorkitemScriptReference getScript()

setScript

public void setScript(WorkitemScriptReference script)

version

public WorkitemVersion version(Integer version)

Version

getVersion

public Integer getVersion()

setVersion

public void setVersion(Integer version)

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