Task (Activiti - Engine 5.15 API)

All Known Implementing Classes:

TaskEntity
```
public interface Task
```
Represents one task for a human user.

Author:

Joram Barrez, Tijs Rademakers

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PRIORITY
Default value used for priority when a new Task is created.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PRIORITY` Default value used for priority when a new `Task` is created.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`delegate(String userId)` delegates this task to the given user and sets the `delegationState` to `DelegationState.PENDING`.
`String`	`getAssignee()` The `userId` of the person to which this task is delegated.
`String`	`getCategory()` The category of the task.
`Date`	`getCreateTime()` The date/time when this task was created
`DelegationState`	`getDelegationState()` The current `DelegationState` for this task.
`String`	`getDescription()` Free text description of the task.
`Date`	`getDueDate()` Due date of the task.
`String`	`getExecutionId()` Reference to the path of execution or null if it is not related to a process instance.
`String`	`getId()` DB id of the task.
`String`	`getName()` Name or title of the task.
`String`	`getOwner()` The `userId` of the person that is responsible for this task.
`String`	`getParentTaskId()` the parent task for which this task is a subtask
`int`	`getPriority()` Indication of how important/urgent this task is
`String`	`getProcessDefinitionId()` Reference to the process definition or null if it is not related to a process.
`String`	`getProcessInstanceId()` Reference to the process instance or null if it is not related to a process instance.
`Map<String,Object>`	`getProcessVariables()` Returns the process variables if requested in the task query
`String`	`getTaskDefinitionKey()` The id of the activity in the process defining this task or null if this is not related to a process
`Map<String,Object>`	`getTaskLocalVariables()` Returns the local task variables if requested in the task query
`String`	`getTenantId()` The tenant identifier of this task
`boolean`	`isSuspended()` Indicated whether this task is suspended or not.
`void`	`setAssignee(String assignee)` The `userId` of the person to which this task is delegated.
`void`	`setCategory(String category)` Change the category of the task.
`void`	`setDelegationState(DelegationState delegationState)` The current `DelegationState` for this task.
`void`	`setDescription(String description)` Change the description of the task
`void`	`setDueDate(Date dueDate)` Change due date of the task.
`void`	`setName(String name)` Name or title of the task.
`void`	`setOwner(String owner)` The `userId` of the person that is responsible for this task.
`void`	`setParentTaskId(String parentTaskId)` the parent task for which this task is a subtask
`void`	`setPriority(int priority)` Sets the indication of how important/urgent this task is

- Field Detail
  - DEFAULT_PRIORITY
```
static final int DEFAULT_PRIORITY
```
    Default value used for priority when a new Task is created.
    
    See Also:
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    DB id of the task.
  - getName
```
String getName()
```
    Name or title of the task.
  - setName
```
void setName(String name)
```
    Name or title of the task.
  - getDescription
```
String getDescription()
```
    Free text description of the task.
  - setDescription
```
void setDescription(String description)
```
    Change the description of the task
  - getPriority
```
int getPriority()
```
    Indication of how important/urgent this task is
  - setPriority
```
void setPriority(int priority)
```
    Sets the indication of how important/urgent this task is
  - getOwner
```
String getOwner()
```
    The userId of the person that is responsible for this task.
  - setOwner
```
void setOwner(String owner)
```
    The userId of the person that is responsible for this task.
  - getAssignee
```
String getAssignee()
```
    The userId of the person to which this task is delegated.
  - setAssignee
```
void setAssignee(String assignee)
```
    The userId of the person to which this task is delegated.
  - getDelegationState
```
DelegationState getDelegationState()
```
    The current DelegationState for this task.
  - setDelegationState
```
void setDelegationState(DelegationState delegationState)
```
    The current DelegationState for this task.
  - getProcessInstanceId
```
String getProcessInstanceId()
```
    Reference to the process instance or null if it is not related to a process instance.
  - getExecutionId
```
String getExecutionId()
```
    Reference to the path of execution or null if it is not related to a process instance.
  - getProcessDefinitionId
```
String getProcessDefinitionId()
```
    Reference to the process definition or null if it is not related to a process.
  - getCreateTime
```
Date getCreateTime()
```
    The date/time when this task was created
  - getTaskDefinitionKey
```
String getTaskDefinitionKey()
```
    The id of the activity in the process defining this task or null if this is not related to a process
  - getDueDate
```
Date getDueDate()
```
    Due date of the task.
  - setDueDate
```
void setDueDate(Date dueDate)
```
    Change due date of the task.
  - getCategory
```
String getCategory()
```
    The category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
  - setCategory
```
void setCategory(String category)
```
    Change the category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
  - delegate
```
void delegate(String userId)
```
    delegates this task to the given user and sets the delegationState to DelegationState.PENDING. If no owner is set on the task, the owner is set to the current assignee of the task.
  - setParentTaskId
```
void setParentTaskId(String parentTaskId)
```
    the parent task for which this task is a subtask
  - getParentTaskId
```
String getParentTaskId()
```
    the parent task for which this task is a subtask
  - isSuspended
```
boolean isSuspended()
```
    Indicated whether this task is suspended or not.
  - getTenantId
```
String getTenantId()
```
    The tenant identifier of this task
  - getTaskLocalVariables
```
Map<String,Object> getTaskLocalVariables()
```
    Returns the local task variables if requested in the task query
  - getProcessVariables
```
Map<String,Object> getProcessVariables()
```
    Returns the process variables if requested in the task query

Interface Task

Field Summary

Method Summary

Field Detail

DEFAULT_PRIORITY

Method Detail

getId

getName

setName

getDescription

setDescription

getPriority

setPriority

getOwner

setOwner

getAssignee

setAssignee

getDelegationState

setDelegationState

getProcessInstanceId

getExecutionId

getProcessDefinitionId

getCreateTime

getTaskDefinitionKey

getDueDate

setDueDate

getCategory

setCategory

delegate

setParentTaskId

getParentTaskId

isSuspended

getTenantId

getTaskLocalVariables

getProcessVariables