Interface UserTask
- All Known Implementing Classes:
UserTaskImpl
public interface UserTask
-
Method Summary
Modifier and TypeMethodDescriptionAssignee of the taskBPMN process id of the process associated with this taskReturns the business ID of the owning process instance, inherited when the user task was created.Candidate groups for the taskCandidate users for the taskCompletion date of the taskCreation date of the taskCustom headers associated with the taskDue date of the taskElement IDInstance key of the elementExternal form referenceFollow-up date of the taskKey of the formgetName()Name of the taskPriority of the taskKey of the process definitionVersion of the process definitionKey of the process instanceName of the process definitionReturns the key of the root process instance.getState()State of the taskgetTags()Tags associated with the taskTenant identifiers
-
Method Details
-
getUserTaskKey
Long getUserTaskKey() -
getName
String getName()Name of the task -
getState
UserTaskState getState()State of the task -
getAssignee
String getAssignee()Assignee of the task -
getElementId
String getElementId()Element ID -
getElementInstanceKey
Long getElementInstanceKey()Instance key of the element -
getCandidateGroups
Candidate groups for the task -
getCandidateUsers
Candidate users for the task -
getBpmnProcessId
String getBpmnProcessId()BPMN process id of the process associated with this task -
getProcessName
String getProcessName()Name of the process definition -
getProcessDefinitionKey
Long getProcessDefinitionKey()Key of the process definition -
getProcessInstanceKey
Long getProcessInstanceKey()Key of the process instance -
getRootProcessInstanceKey
Long getRootProcessInstanceKey()Returns the key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy.Note: This field is
nullfor process instance hierarchies created before version 8.9.- Returns:
- the root process instance key, or
nullfor data created before version 8.9
-
getBusinessId
String getBusinessId()Returns the business ID of the owning process instance, inherited when the user task was created.Note: This field is
nullfor user tasks created before version 8.10, and when the owning process instance has no business ID.- Returns:
- the business ID, or
nullwhen not set
-
getFormKey
Long getFormKey()Key of the form -
getCreationDate
OffsetDateTime getCreationDate()Creation date of the task -
getCompletionDate
OffsetDateTime getCompletionDate()Completion date of the task -
getFollowUpDate
OffsetDateTime getFollowUpDate()Follow-up date of the task -
getDueDate
OffsetDateTime getDueDate()Due date of the task -
getTenantId
String getTenantId()Tenant identifiers -
getExternalFormReference
String getExternalFormReference()External form reference -
getProcessDefinitionVersion
Integer getProcessDefinitionVersion()Version of the process definition -
getCustomHeaders
Custom headers associated with the task -
getPriority
Integer getPriority()Priority of the task -
getTags
Tags associated with the task
-