Interface WorkflowTask
- All Superinterfaces:
Entity,Resource,Serializable
Represents an uncompleted workflow task.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the aggregation key.Deprecated.This method will be removed in the future.Returns the business item reference with nameNamedResourceReferencerelated to the task.Returns the candidate users.Returns the create time.Returns the custom buttons.Returns the description.Returns the due date.Returns the error message in case this task is in error.getKey()Returns the key.getOwner()Returns the owner.intReturns the priority.getTitle()Returns the title of the task.getType()Returns the type.Returns the reference to the workflow definition.Returns the UUID of the workflow instance.booleanReturns a boolean indicating whether this workflow task is cancelable or not.booleanReturns a boolean indicating whether this task contains an activity stream or not.booleanReturns a boolean indicating whether this task has form key available.booleanReturns a boolean indicating whether this task requires a form or not.booleanReturns whether this task is in error or not.booleanReturns a boolean indicating whether this workflow task is reassignable or not.Methods inherited from interface Resource
getCreatedBy, getCreatedOn, getLastModifiedBy, getLastModifiedOn, getResourceType, isSystem
-
Method Details
-
getWorkflowDefinition
WorkflowDefinitionReference getWorkflowDefinition()Returns the reference to the workflow definition.- Returns:
- the reference to the workflow definition
-
getWorkflowInstanceId
UUID getWorkflowInstanceId()Returns the UUID of the workflow instance.- Returns:
- the UUID of the workflow instance
-
getKey
String getKey()Returns the key.- Returns:
- the key
-
getType
String getType()Returns the type.- Returns:
- the type
-
getAggregationKey
String getAggregationKey()Returns the aggregation key.- Returns:
- the aggregation key
-
getPriority
int getPriority()Returns the priority.- Returns:
- the priority
-
getOwner
String getOwner()Returns the owner.- Returns:
- the owner
-
getCandidateUsers
Returns the candidate users.- Returns:
- the candidate users
-
getCreateTime
Long getCreateTime()Returns the create time.- Returns:
- the create time
-
getDueDate
Long getDueDate()Returns the due date.- Returns:
- the due date
-
isCancelable
boolean isCancelable()Returns a boolean indicating whether this workflow task is cancelable or not.- Returns:
- a boolean indicating whether this workflow task is cancelable or not
-
isReassignable
boolean isReassignable()Returns a boolean indicating whether this workflow task is reassignable or not.- Returns:
- a boolean indicating whether this task is reassignable or not
-
isFormRequired
boolean isFormRequired()Returns a boolean indicating whether this task requires a form or not.- Returns:
- a boolean indicating whether this task requires a form or not
-
isFormKeyAvailable
boolean isFormKeyAvailable()Returns a boolean indicating whether this task has form key available. The form key is an indicator to json object which holds definition of form content and layout- Returns:
- a boolean indicating whether this task has form key available
-
isContainsActivityStream
boolean isContainsActivityStream()Returns a boolean indicating whether this task contains an activity stream or not.- Returns:
- a boolean indicating whether this task contains an activity stream or not
-
isInError
boolean isInError()Returns whether this task is in error or not.- Returns:
- a boolean indicating whether this task is in error or not
-
getErrorMessage
String getErrorMessage()Returns the error message in case this task is in error.- Returns:
- the error message
-
getCustomButtons
List<FormProperty> getCustomButtons()Returns the custom buttons.- Returns:
- the custom buttons
-
getDescription
String getDescription()Returns the description.- Returns:
- the description
-
getTitle
String getTitle()Returns the title of the task.- Returns:
- the title
-
getBusinessItem
ResourceReference getBusinessItem()Deprecated.This method will be removed in the future. Please usegetBusinessItemReference()Returns the business itemResourceReferencerelated to the task. -
getBusinessItemReference
NamedResourceReference getBusinessItemReference()Returns the business item reference with nameNamedResourceReferencerelated to the task.- Returns:
- the businessItem
-