Class Workitem

java.lang.Object
com.mypurecloud.sdk.v2.model.Workitem
All Implemented Interfaces:
Serializable

public class Workitem extends Object implements Serializable
Workitem
See Also:
  • Constructor Details

    • Workitem

      public Workitem()
    • Workitem

      public Workitem(Boolean initWithEmptyList)
  • Method Details

    • getId

      public String getId()
    • name

      public Workitem name(String name)
      The name of the Workitem.
    • getName

      public String getName()
    • setName

      public void setName(String name)
    • division

      public Workitem division(Division division)
      The division to which this entity belongs.
    • getDivision

      public Division getDivision()
    • setDivision

      public void setDivision(Division division)
    • type

      public Workitem type(WorktypeReference type)
      The Worktype of the Workitem.
    • getType

      public WorktypeReference getType()
    • setType

      public void setType(WorktypeReference type)
    • description

      public Workitem description(String description)
      The description of the Workitem.
    • getDescription

      public String getDescription()
    • setDescription

      public void setDescription(String description)
    • language

      public Workitem language(LanguageReference language)
      The language of the Workitem.
    • getLanguage

      public LanguageReference getLanguage()
    • setLanguage

      public void setLanguage(LanguageReference language)
    • utilizationLabel

      public Workitem utilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)
      The utilization label of the Workitem.
    • getUtilizationLabel

      public WorkitemUtilizationLabelReference getUtilizationLabel()
    • setUtilizationLabel

      public void setUtilizationLabel(WorkitemUtilizationLabelReference utilizationLabel)
    • priority

      public Workitem 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 Workitem 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 Workitem 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 Workitem 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 Workitem 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 Workitem durationSeconds(Integer durationSeconds)
      The estimated duration in seconds to complete the workitem.
    • getDurationSeconds

      public Integer getDurationSeconds()
    • setDurationSeconds

      public void setDurationSeconds(Integer durationSeconds)
    • ttl

      public Workitem ttl(Integer ttl)
      The time to live of the Workitem in seconds.
    • getTtl

      public Integer getTtl()
    • setTtl

      public void setTtl(Integer ttl)
    • status

      public Workitem status(WorkitemStatusReference status)
      The current Status of the Workitem.
    • getStatus

      public WorkitemStatusReference getStatus()
    • setStatus

      public void setStatus(WorkitemStatusReference status)
    • statusCategory

      public Workitem statusCategory(Workitem.StatusCategoryEnum statusCategory)
      The Category of the current Status of the Workitem.
    • getStatusCategory

      public Workitem.StatusCategoryEnum getStatusCategory()
    • setStatusCategory

      public void setStatusCategory(Workitem.StatusCategoryEnum statusCategory)
    • dateStatusChanged

      public Workitem 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 Workitem 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 Workitem workbin(WorkbinReference workbin)
      The Workbin that contains the Workitem.
    • getWorkbin

      public WorkbinReference getWorkbin()
    • setWorkbin

      public void setWorkbin(WorkbinReference workbin)
    • reporter

      public Workitem reporter(UserReferenceWithName reporter)
      The reporter of the Workitem.
    • getReporter

      public UserReferenceWithName getReporter()
    • setReporter

      public void setReporter(UserReferenceWithName reporter)
    • assignee

      public Workitem assignee(UserReferenceWithName assignee)
      The assignee of the Workitem.
    • getAssignee

      public UserReferenceWithName getAssignee()
    • setAssignee

      public void setAssignee(UserReferenceWithName assignee)
    • externalContact

      public Workitem externalContact(ExternalContactReference externalContact)
      The external contact of the Workitem.
    • getExternalContact

      public ExternalContactReference getExternalContact()
    • setExternalContact

      public void setExternalContact(ExternalContactReference externalContact)
    • externalTag

      public Workitem externalTag(String externalTag)
      The external tag of the Workitem.
    • getExternalTag

      public String getExternalTag()
    • setExternalTag

      public void setExternalTag(String externalTag)
    • modifiedBy

      public Workitem modifiedBy(UserReference modifiedBy)
      The User who modified the Workitem.
    • getModifiedBy

      public UserReference getModifiedBy()
    • setModifiedBy

      public void setModifiedBy(UserReference modifiedBy)
    • queue

      public Workitem queue(WorkitemQueueReference queue)
      The Workitems queue.
    • getQueue

      public WorkitemQueueReference getQueue()
    • setQueue

      public void setQueue(WorkitemQueueReference queue)
    • assignmentState

      public Workitem assignmentState(Workitem.AssignmentStateEnum assignmentState)
      The assignment state of the workitem.
    • getAssignmentState

      public Workitem.AssignmentStateEnum getAssignmentState()
    • setAssignmentState

      public void setAssignmentState(Workitem.AssignmentStateEnum assignmentState)
    • dateAssignmentStateChanged

      public Workitem 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 Workitem alertTimeoutSeconds(Integer alertTimeoutSeconds)
      The duration in seconds before an alert will timeout.
    • getAlertTimeoutSeconds

      public Integer getAlertTimeoutSeconds()
    • setAlertTimeoutSeconds

      public void setAlertTimeoutSeconds(Integer alertTimeoutSeconds)
    • skills

      public Workitem skills(List<RoutingSkillReference> skills)
      The skills of the Workitem.
    • getSkills

      public List<RoutingSkillReference> getSkills()
    • setSkills

      public void setSkills(List<RoutingSkillReference> skills)
    • preferredAgents

      public Workitem preferredAgents(List<UserReference> preferredAgents)
      The preferred agents of the Workitem.
    • getPreferredAgents

      public List<UserReference> getPreferredAgents()
    • setPreferredAgents

      public void setPreferredAgents(List<UserReference> preferredAgents)
    • autoStatusTransition

      public Workitem 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 Workitem 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 Workitem 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 Workitem autoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)
      Auto status transition details of Workitem.
    • getAutoStatusTransitionDetail

      public AutoStatusTransitionDetail getAutoStatusTransitionDetail()
    • setAutoStatusTransitionDetail

      public void setAutoStatusTransitionDetail(AutoStatusTransitionDetail autoStatusTransitionDetail)
    • scoredAgents

      public Workitem 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 Workitem script(WorkitemScriptReference script)
      The script that will be executed for the Workitem.
    • getScript

      public WorkitemScriptReference getScript()
    • setScript

      public void setScript(WorkitemScriptReference script)
    • 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