TaskEntityImpl (Flowable 6.7.0 API)

java.lang.Object
- org.flowable.common.engine.impl.persistence.entity.AbstractEntity
- - org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl
  - - org.flowable.task.service.impl.persistence.entity.AbstractTaskServiceVariableScopeEntity
    - - org.flowable.task.service.impl.persistence.entity.TaskEntityImpl

All Implemented Interfaces:

Serializable, VariableContainer, HasRevision, Entity, Task, TaskInfo, DelegateTask, CountingTaskEntity, TaskEntity, VariableScope
```
public class TaskEntityImpl
extends AbstractTaskServiceVariableScopeEntity
implements TaskEntity, CountingTaskEntity, Serializable
```
Author:

Tom Baeyens, Joram Barrez, Falko Menge, Tijs Rademakers

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`assignee`
`protected int`	`assigneeUpdatedCount`
`protected String`	`category`
`protected Date`	`claimTime`
`protected Date`	`createTime`
`protected DelegationState`	`delegationState`
`static String`	`DELETE_REASON_COMPLETED`
`static String`	`DELETE_REASON_DELETED`
`protected String`	`description`
`protected Date`	`dueDate`
`protected String`	`eventHandlerId`
`protected String`	`eventName`
`protected String`	`executionId`
`protected boolean`	`forcedUpdate`
`protected String`	`formKey`
`protected int`	`identityLinkCount`
`protected boolean`	`isCanceled`
`protected boolean`	`isIdentityLinksInitialized`
`protected String`	`localizedDescription`
`protected String`	`localizedName`
`protected String`	`name`
`protected String`	`originalAssignee`
`protected String`	`owner`
`protected String`	`parentTaskId`
`protected int`	`priority`
`protected String`	`processDefinitionId`
`protected String`	`processInstanceId`
`protected String`	`propagatedStageInstanceId`
`protected List<IdentityLinkEntity>`	`queryIdentityLinks`
`protected List<VariableInstanceEntity>`	`queryVariables`
`protected String`	`scopeDefinitionId`
`protected String`	`scopeId`
`protected String`	`scopeType`
`protected String`	`subScopeId`
`protected int`	`subTaskCount`
`protected int`	`suspensionState`
`protected String`	`taskDefinitionId`
`protected String`	`taskDefinitionKey`
`protected List<IdentityLinkEntity>`	`taskIdentityLinkEntities`
`protected String`	`tenantId`
`protected int`	`variableCount`

Fields inherited from class org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl
cachedElContext, transientVariables, usedVariablesCache, variableInstances

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Fields inherited from interface org.flowable.task.api.Task
DEFAULT_PRIORITY

Constructor Summary

Constructors
Constructor and Description

TaskEntityImpl()

Constructors
Constructor and Description
`TaskEntityImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCandidateGroup(String groupId)` Adds the given group as candidate group to this task
`void`	`addCandidateGroups(Collection<String> candidateGroups)` Adds multiple groups as candidate group to this task.
`void`	`addCandidateUser(String userId)` Adds the given user as a candidate user to this task.
`void`	`addCandidateUsers(Collection<String> candidateUsers)` Adds multiple users as candidate user to this task.
`void`	`addGroupIdentityLink(String groupId, String identityLinkType)` Involves a group with group task.
`protected void`	`addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)`
`void`	`addUserIdentityLink(String userId, String identityLinkType)` Involves a user with a task.
`protected List<IdentityLink>`	`convertToIdentityLinks(List<IdentityLinkEntity> identityLinks)`
`protected VariableInstanceEntity`	`createVariableInstance(String variableName, Object value)`
`void`	`deleteCandidateGroup(String groupId)` Convenience shorthand for `DelegateTask.deleteGroupIdentityLink(String, String)`; with type `IdentityLinkType.CANDIDATE`
`void`	`deleteCandidateUser(String userId)` Convenience shorthand for `DelegateTask.deleteUserIdentityLink(String, String)` ; with type `IdentityLinkType.CANDIDATE`
`void`	`deleteGroupIdentityLink(String groupId, String identityLinkType)` Removes the association between a group and a task for the given identityLinkType.
`void`	`deleteUserIdentityLink(String userId, String identityLinkType)` Removes the association between a user and a task for the given identityLinkType.
`protected void`	`deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)`
`void`	`forceUpdate()`
`String`	`getAssignee()` The user id of the person to which this task is delegated.
`Set<IdentityLink>`	`getCandidates()` Retrieves the candidate users and groups associated with the task.
`String`	`getCategory()` The category of the task.
`Date`	`getClaimTime()` The claim time of this task
`Date`	`getCreateTime()` The date/time when this task was created
`DelegationState`	`getDelegationState()` The current `DelegationState` for this task.
`String`	`getDelegationStateString()`
`String`	`getDescription()` Free text description of the task.
`Date`	`getDueDate()` Due date of the task.
`String`	`getEventHandlerId()` Returns the event handler identifier which triggered the task listener to fire for this task.
`String`	`getEventName()` Returns the event name which triggered the task listener to fire for this task.
`String`	`getExecutionId()` Reference to the path of execution or null if it is not related to a process instance.
`String`	`getFormKey()` The form key for the user task
`int`	`getIdentityLinkCount()`
`List<IdentityLinkEntity>`	`getIdentityLinks()` Returns the identity links.
`protected IdentityLinkServiceConfiguration`	`getIdentityLinkServiceConfiguration()`
`boolean`	`getIsCountEnabled()`
`String`	`getLocalizedDescription()`
`String`	`getLocalizedName()`
`String`	`getName()` Name or title of the task.
`String`	`getOriginalAssignee()`
`String`	`getOwner()` The user id of the person that is responsible for this task.
`String`	`getParentTaskId()` The parent task for which this task is a subtask
`protected VariableScopeImpl`	`getParentVariableScope()`
`Object`	`getPersistentState()` Returns a representation of the object, as would be stored in the database.
`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`	`getPropagatedStageInstanceId()` If this task runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise).
`List<IdentityLinkEntity>`	`getQueryIdentityLinks()`
`List<VariableInstanceEntity>`	`getQueryVariables()`
`String`	`getScopeDefinitionId()` Reference to a scope definition identifier or null if none is set (e.g.
`String`	`getScopeId()` Reference to a scope identifier or null if none is set (e.g.
`String`	`getScopeType()` Reference to a scope type or null if none is set (e.g.
`protected VariableInstanceEntity`	`getSpecificVariable(String variableName)`
`protected List<VariableInstanceEntity>`	`getSpecificVariables(Collection<String> variableNames)`
`String`	`getSubScopeId()` Reference to a sub scope identifier or null if none is set (e.g.
`int`	`getSubTaskCount()`
`int`	`getSuspensionState()`
`protected InternalTaskAssignmentManager`	`getTaskAssignmentManager()`
`String`	`getTaskDefinitionId()` Reference to the task definition or null if it is not related to any task definition.
`String`	`getTaskDefinitionKey()` The id of the activity in the process defining this task or null if this is not related to a process
`protected AbstractEngineConfiguration`	`getTaskEngineConfiguration()`
`Map<String,Object>`	`getTaskLocalVariables()` Returns the local task variables if requested in the task query
`protected TaskServiceConfiguration`	`getTaskServiceConfiguration()`
`String`	`getTenantId()` The tenant identifier of this task
`int`	`getVariableCount()`
`Map<String,VariableInstanceEntity>`	`getVariableInstanceEntities()`
`protected VariableServiceConfiguration`	`getVariableServiceConfiguration()`
`protected void`	`initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)`
`boolean`	`isCanceled()`
`boolean`	`isCountEnabled()`
`boolean`	`isDeleted()`
`protected boolean`	`isPropagateToHistoricVariable()` Return whether changes to the variables are propagated to the history storage.
`boolean`	`isSuspended()` Indicates whether this task is suspended or not.
`protected List<VariableInstanceEntity>`	`loadVariableInstances()`
`void`	`setAssignee(String assignee)` The user id of the person to which this task is delegated.
`void`	`setAssigneeValue(String assignee)`
`void`	`setCanceled(boolean isCanceled)`
`void`	`setCategory(String category)` Change the category of the task.
`void`	`setClaimTime(Date claimTime)`
`void`	`setCountEnabled(boolean isCountEnabled)`
`void`	`setCreateTime(Date createTime)`
`void`	`setDelegationState(DelegationState delegationState)` The current `DelegationState` for this task.
`void`	`setDelegationStateString(String delegationStateString)`
`void`	`setDeleted(boolean isDeleted)`
`void`	`setDescription(String description)` Change the description of the task
`void`	`setDueDate(Date dueDate)` Change due date of the task.
`void`	`setEventHandlerId(String eventHandlerId)`
`void`	`setEventName(String eventName)`
`void`	`setExecutionId(String executionId)`
`void`	`setFormKey(String formKey)` Change the form key of the task
`void`	`setIdentityLinkCount(int identityLinkCount)`
`void`	`setIsCountEnabled(boolean isCountEnabled)`
`void`	`setLocalizedDescription(String localizedDescription)` Sets an optional localized description for the task.
`void`	`setLocalizedName(String localizedName)` Sets an optional localized name for the task.
`void`	`setName(String taskName)` Name or title of the task.
`void`	`setOwner(String owner)` The user id of the person that is responsible for this task.
`void`	`setOwnerValue(String owner)`
`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
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setPropagatedStageInstanceId(String propagatedStageInstanceId)`
`void`	`setQueryIdentityLinks(List<IdentityLinkEntity> identityLinks)`
`void`	`setQueryVariables(List<VariableInstanceEntity> queryVariables)`
`void`	`setScopeDefinitionId(String scopeDefinitionId)`
`void`	`setScopeId(String scopeId)`
`void`	`setScopeType(String scopeType)`
`void`	`setSubScopeId(String subScopeId)`
`void`	`setSubTaskCount(int subTaskCount)`
`void`	`setSuspensionState(int suspensionState)`
`void`	`setTaskDefinitionId(String taskDefinitionId)`
`void`	`setTaskDefinitionKey(String taskDefinitionKey)`
`void`	`setTenantId(String tenantId)` Change the tenantId of the task
`void`	`setVariableCount(int variableCount)`
`String`	`toString()`

Methods inherited from class org.flowable.task.service.impl.persistence.entity.AbstractTaskServiceVariableScopeEntity
getIdPrefix

Methods inherited from class org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl
collectTransientVariables, collectVariableInstances, collectVariableNames, collectVariables, createVariableLocal, createVariablesLocal, ensureVariableInstancesInitialized, getCachedElContext, getTransientVariable, getTransientVariableLocal, getTransientVariables, getTransientVariablesLocal, getUsedVariablesCache, getVariable, getVariable, getVariable, getVariableInstance, getVariableInstance, getVariableInstanceLocal, getVariableInstanceLocal, getVariableInstances, getVariableInstances, getVariableInstances, getVariableInstancesLocal, getVariableInstancesLocal, getVariableInstancesLocal, getVariableLocal, getVariableLocal, getVariableLocal, getVariableNames, getVariableNamesLocal, getVariables, getVariables, getVariables, getVariablesLocal, getVariablesLocal, getVariablesLocal, hasVariable, hasVariableLocal, hasVariables, hasVariablesLocal, internalSetVariableInstances, isExpression, removeTransientVariable, removeTransientVariableLocal, removeTransientVariables, removeTransientVariablesLocal, removeVariable, removeVariableLocal, removeVariables, removeVariables, removeVariablesLocal, removeVariablesLocal, setCachedElContext, setTransientVariable, setTransientVariableLocal, setTransientVariables, setTransientVariablesLocal, setVariable, setVariable, setVariableLocal, setVariableLocal, setVariables, setVariablesLocal, storeVariableLocal, updateVariableInstance

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
getId, getOriginalPersistentState, getRevision, getRevisionNext, isInserted, isUpdated, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.flowable.task.api.TaskInfo
getId

Methods inherited from interface org.flowable.task.service.delegate.DelegateTask
getId

Methods inherited from interface org.flowable.variable.api.delegate.VariableScope
getTransientVariable, getTransientVariableLocal, getTransientVariables, getTransientVariablesLocal, getVariable, getVariable, getVariable, getVariableInstance, getVariableInstance, getVariableInstanceLocal, getVariableInstanceLocal, getVariableInstances, getVariableInstances, getVariableInstances, getVariableInstancesLocal, getVariableInstancesLocal, getVariableInstancesLocal, getVariableLocal, getVariableLocal, getVariableLocal, getVariableNames, getVariableNamesLocal, getVariables, getVariables, getVariables, getVariablesLocal, getVariablesLocal, getVariablesLocal, hasVariable, hasVariableLocal, hasVariables, hasVariablesLocal, removeTransientVariable, removeTransientVariableLocal, removeTransientVariables, removeTransientVariablesLocal, removeVariable, removeVariableLocal, removeVariables, removeVariables, removeVariablesLocal, removeVariablesLocal, setTransientVariable, setTransientVariableLocal, setTransientVariables, setTransientVariablesLocal, setVariable, setVariable, setVariableLocal, setVariableLocal, setVariables, setVariablesLocal

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity
getId, getIdPrefix, getOriginalPersistentState, isInserted, isUpdated, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision
getRevision, getRevisionNext, setRevision

- Field Detail
  - DELETE_REASON_COMPLETED
```
public static final String DELETE_REASON_COMPLETED
```
    See Also:
    
    Constant Field Values
  - DELETE_REASON_DELETED
```
public static final String DELETE_REASON_DELETED
```
    See Also:
    
    Constant Field Values
  - owner
```
protected String owner
```
  - assigneeUpdatedCount
```
protected int assigneeUpdatedCount
```
  - originalAssignee
```
protected String originalAssignee
```
  - assignee
```
protected String assignee
```
  - delegationState
```
protected DelegationState delegationState
```
  - parentTaskId
```
protected String parentTaskId
```
  - name
```
protected String name
```
  - localizedName
```
protected String localizedName
```
  - description
```
protected String description
```
  - localizedDescription
```
protected String localizedDescription
```
  - priority
```
protected int priority
```
  - createTime
```
protected Date createTime
```
  - dueDate
```
protected Date dueDate
```
  - suspensionState
```
protected int suspensionState
```
  - category
```
protected String category
```
  - isIdentityLinksInitialized
```
protected boolean isIdentityLinksInitialized
```
  - taskIdentityLinkEntities
```
protected List<IdentityLinkEntity> taskIdentityLinkEntities
```
  - executionId
```
protected String executionId
```
  - processInstanceId
```
protected String processInstanceId
```
  - processDefinitionId
```
protected String processDefinitionId
```
  - taskDefinitionId
```
protected String taskDefinitionId
```
  - scopeId
```
protected String scopeId
```
  - subScopeId
```
protected String subScopeId
```
  - scopeType
```
protected String scopeType
```
  - scopeDefinitionId
```
protected String scopeDefinitionId
```
  - propagatedStageInstanceId
```
protected String propagatedStageInstanceId
```
  - taskDefinitionKey
```
protected String taskDefinitionKey
```
  - formKey
```
protected String formKey
```
  - isCanceled
```
protected boolean isCanceled
```
  - variableCount
```
protected int variableCount
```
  - identityLinkCount
```
protected int identityLinkCount
```
  - subTaskCount
```
protected int subTaskCount
```
  - claimTime
```
protected Date claimTime
```
  - tenantId
```
protected String tenantId
```
  - eventName
```
protected String eventName
```
  - eventHandlerId
```
protected String eventHandlerId
```
  - queryVariables
```
protected List<VariableInstanceEntity> queryVariables
```
  - queryIdentityLinks
```
protected List<IdentityLinkEntity> queryIdentityLinks
```
  - forcedUpdate
```
protected boolean forcedUpdate
```
- Constructor Detail
  - TaskEntityImpl
```
public TaskEntityImpl()
```
- Method Detail
  - getPersistentState
```
public Object getPersistentState()
```
    Description copied from interface: Entity
    
    Returns a representation of the object, as would be stored in the database. Used when deciding if updates have occurred to the object or not since it was last loaded.
    
    Specified by:
    
    getPersistentState in interface Entity
  - forceUpdate
```
public void forceUpdate()
```
    Specified by:
    
    forceUpdate in interface TaskEntity
  - getParentVariableScope
```
protected VariableScopeImpl getParentVariableScope()
```
    Specified by:
    
    getParentVariableScope in class VariableScopeImpl
  - initializeVariableInstanceBackPointer
```
protected void initializeVariableInstanceBackPointer(VariableInstanceEntity variableInstance)
```
    Specified by:
    
    initializeVariableInstanceBackPointer in class VariableScopeImpl
  - addLoggingSessionInfo
```
protected void addLoggingSessionInfo(com.fasterxml.jackson.databind.node.ObjectNode loggingNode)
```
    Specified by:
    
    addLoggingSessionInfo in class VariableScopeImpl
  - loadVariableInstances
```
protected List<VariableInstanceEntity> loadVariableInstances()
```
    Specified by:
    
    loadVariableInstances in class VariableScopeImpl
  - createVariableInstance
```
protected VariableInstanceEntity createVariableInstance(String variableName,
                                                        Object value)
```
    Overrides:
    
    createVariableInstance in class VariableScopeImpl
  - deleteVariableInstanceForExplicitUserCall
```
protected void deleteVariableInstanceForExplicitUserCall(VariableInstanceEntity variableInstance)
```
    Overrides:
    
    deleteVariableInstanceForExplicitUserCall in class VariableScopeImpl
  - getCandidates
```
public Set<IdentityLink> getCandidates()
```
    Description copied from interface: DelegateTask
    
    Retrieves the candidate users and groups associated with the task.
    
    Specified by:
    
    getCandidates in interface DelegateTask
    
    Returns:
    
    set of IdentityLinks of type IdentityLinkType.CANDIDATE.
  - getIdentityLinks
```
public List<IdentityLinkEntity> getIdentityLinks()
```
    Description copied from interface: TaskInfo
    
    Returns the identity links.
    
    Specified by:
    
    getIdentityLinks in interface TaskInfo
    
    Specified by:
    
    getIdentityLinks in interface TaskEntity
  - setName
```
public void setName(String taskName)
```
    Description copied from interface: Task
    
    Name or title of the task.
    
    Specified by:
    
    setName in interface Task
    
    Specified by:
    
    setName in interface DelegateTask
  - setDescription
```
public void setDescription(String description)
```
    Description copied from interface: Task
    
    Change the description of the task
    
    Specified by:
    
    setDescription in interface Task
    
    Specified by:
    
    setDescription in interface DelegateTask
  - setAssignee
```
public void setAssignee(String assignee)
```
    Description copied from interface: Task
    
    The user id of the person to which this task is delegated.
    
    Specified by:
    
    setAssignee in interface Task
    
    Specified by:
    
    setAssignee in interface DelegateTask
  - setAssigneeValue
```
public void setAssigneeValue(String assignee)
```
    Specified by:
    
    setAssigneeValue in interface TaskEntity
  - setOwner
```
public void setOwner(String owner)
```
    Description copied from interface: Task
    
    The user id of the person that is responsible for this task.
    
    Specified by:
    
    setOwner in interface Task
    
    Specified by:
    
    setOwner in interface DelegateTask
  - setOwnerValue
```
public void setOwnerValue(String owner)
```
    Specified by:
    
    setOwnerValue in interface TaskEntity
  - setDueDate
```
public void setDueDate(Date dueDate)
```
    Description copied from interface: Task
    
    Change due date of the task.
    
    Specified by:
    
    setDueDate in interface Task
    
    Specified by:
    
    setDueDate in interface DelegateTask
  - setPriority
```
public void setPriority(int priority)
```
    Description copied from interface: Task
    
    Sets the indication of how important/urgent this task is
    
    Specified by:
    
    setPriority in interface Task
    
    Specified by:
    
    setPriority in interface DelegateTask
  - setCategory
```
public void setCategory(String category)
```
    Description copied from interface: Task
    
    Change the category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
    
    Specified by:
    
    setCategory in interface Task
    
    Specified by:
    
    setCategory in interface DelegateTask
  - addUserIdentityLink
```
public void addUserIdentityLink(String userId,
                                String identityLinkType)
```
    Description copied from interface: DelegateTask
    
    Involves a user with a task. The type of identity link is defined by the given identityLinkType.
    
    Specified by:
    
    addUserIdentityLink in interface DelegateTask
    
    Parameters:
    
    userId - id of the user involve, cannot be null.
    
    identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
  - addGroupIdentityLink
```
public void addGroupIdentityLink(String groupId,
                                 String identityLinkType)
```
    Description copied from interface: DelegateTask
    
    Involves a group with group task. The type of identityLink is defined by the given identityLink.
    
    Specified by:
    
    addGroupIdentityLink in interface DelegateTask
    
    Parameters:
    
    groupId - id of the group to involve, cannot be null.
    
    identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
  - deleteCandidateUser
```
public void deleteCandidateUser(String userId)
```
    Description copied from interface: DelegateTask
    
    Convenience shorthand for DelegateTask.deleteUserIdentityLink(String, String) ; with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    deleteCandidateUser in interface DelegateTask
    
    Parameters:
    
    userId - id of the user to use as candidate, cannot be null.
  - deleteCandidateGroup
```
public void deleteCandidateGroup(String groupId)
```
    Description copied from interface: DelegateTask
    
    Convenience shorthand for DelegateTask.deleteGroupIdentityLink(String, String); with type IdentityLinkType.CANDIDATE
    
    Specified by:
    
    deleteCandidateGroup in interface DelegateTask
    
    Parameters:
    
    groupId - id of the group to use as candidate, cannot be null.
  - deleteUserIdentityLink
```
public void deleteUserIdentityLink(String userId,
                                   String identityLinkType)
```
    Description copied from interface: DelegateTask
    
    Removes the association between a user and a task for the given identityLinkType.
    
    Specified by:
    
    deleteUserIdentityLink in interface DelegateTask
    
    Parameters:
    
    userId - id of the user involve, cannot be null.
    
    identityLinkType - type of identityLink, cannot be null (@see IdentityLinkType).
  - deleteGroupIdentityLink
```
public void deleteGroupIdentityLink(String groupId,
                                    String identityLinkType)
```
    Description copied from interface: DelegateTask
    
    Removes the association between a group and a task for the given identityLinkType.
    
    Specified by:
    
    deleteGroupIdentityLink in interface DelegateTask
    
    Parameters:
    
    groupId - id of the group to involve, cannot be null.
    
    identityLinkType - type of identity, cannot be null (@see IdentityLinkType).
  - setParentTaskId
```
public void setParentTaskId(String parentTaskId)
```
    Description copied from interface: Task
    
    the parent task for which this task is a subtask
    
    Specified by:
    
    setParentTaskId in interface Task
  - getFormKey
```
public String getFormKey()
```
    Description copied from interface: TaskInfo
    
    The form key for the user task
    
    Specified by:
    
    getFormKey in interface TaskInfo
    
    Specified by:
    
    getFormKey in interface DelegateTask
  - setFormKey
```
public void setFormKey(String formKey)
```
    Description copied from interface: Task
    
    Change the form key of the task
    
    Specified by:
    
    setFormKey in interface Task
    
    Specified by:
    
    setFormKey in interface DelegateTask
  - isPropagateToHistoricVariable
```
protected boolean isPropagateToHistoricVariable()
```
    Description copied from class: VariableScopeImpl
    
    Return whether changes to the variables are propagated to the history storage.
    
    Specified by:
    
    isPropagateToHistoricVariable in class VariableScopeImpl
  - getSpecificVariable
```
protected VariableInstanceEntity getSpecificVariable(String variableName)
```
    Specified by:
    
    getSpecificVariable in class VariableScopeImpl
  - getSpecificVariables
```
protected List<VariableInstanceEntity> getSpecificVariables(Collection<String> variableNames)
```
    Specified by:
    
    getSpecificVariables in class VariableScopeImpl
  - getName
```
public String getName()
```
    Description copied from interface: TaskInfo
    
    Name or title of the task.
    
    Specified by:
    
    getName in interface TaskInfo
    
    Specified by:
    
    getName in interface DelegateTask
  - getLocalizedName
```
public String getLocalizedName()
```
  - setLocalizedName
```
public void setLocalizedName(String localizedName)
```
    Description copied from interface: Task
    
    Sets an optional localized name for the task.
    
    Specified by:
    
    setLocalizedName in interface Task
  - getDescription
```
public String getDescription()
```
    Description copied from interface: TaskInfo
    
    Free text description of the task.
    
    Specified by:
    
    getDescription in interface TaskInfo
    
    Specified by:
    
    getDescription in interface DelegateTask
  - getLocalizedDescription
```
public String getLocalizedDescription()
```
  - setLocalizedDescription
```
public void setLocalizedDescription(String localizedDescription)
```
    Description copied from interface: Task
    
    Sets an optional localized description for the task.
    
    Specified by:
    
    setLocalizedDescription in interface Task
  - getDueDate
```
public Date getDueDate()
```
    Description copied from interface: TaskInfo
    
    Due date of the task.
    
    Specified by:
    
    getDueDate in interface TaskInfo
    
    Specified by:
    
    getDueDate in interface DelegateTask
  - getPriority
```
public int getPriority()
```
    Description copied from interface: TaskInfo
    
    Indication of how important/urgent this task is
    
    Specified by:
    
    getPriority in interface TaskInfo
    
    Specified by:
    
    getPriority in interface DelegateTask
  - getCreateTime
```
public Date getCreateTime()
```
    Description copied from interface: TaskInfo
    
    The date/time when this task was created
    
    Specified by:
    
    getCreateTime in interface TaskInfo
    
    Specified by:
    
    getCreateTime in interface DelegateTask
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
    Specified by:
    
    setCreateTime in interface TaskEntity
  - getExecutionId
```
public String getExecutionId()
```
    Description copied from interface: TaskInfo
    
    Reference to the path of execution or null if it is not related to a process instance.
    
    Specified by:
    
    getExecutionId in interface TaskInfo
    
    Specified by:
    
    getExecutionId in interface DelegateTask
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    Description copied from interface: TaskInfo
    
    Reference to the process instance or null if it is not related to a process instance.
    
    Specified by:
    
    getProcessInstanceId in interface TaskInfo
    
    Specified by:
    
    getProcessInstanceId in interface DelegateTask
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    Description copied from interface: TaskInfo
    
    Reference to the process definition or null if it is not related to a process.
    
    Specified by:
    
    getProcessDefinitionId in interface TaskInfo
    
    Specified by:
    
    getProcessDefinitionId in interface DelegateTask
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
    Specified by:
    
    setProcessDefinitionId in interface TaskEntity
  - getTaskDefinitionId
```
public String getTaskDefinitionId()
```
    Description copied from interface: TaskInfo
    
    Reference to the task definition or null if it is not related to any task definition.
    
    Specified by:
    
    getTaskDefinitionId in interface TaskInfo
  - setTaskDefinitionId
```
public void setTaskDefinitionId(String taskDefinitionId)
```
    Specified by:
    
    setTaskDefinitionId in interface TaskEntity
  - getScopeId
```
public String getScopeId()
```
    Description copied from interface: TaskInfo
    
    Reference to a scope identifier or null if none is set (e.g. for bpmn process task it is null)
    
    Specified by:
    
    getScopeId in interface TaskInfo
  - setScopeId
```
public void setScopeId(String scopeId)
```
    Specified by:
    
    setScopeId in interface TaskEntity
  - getSubScopeId
```
public String getSubScopeId()
```
    Description copied from interface: TaskInfo
    
    Reference to a sub scope identifier or null if none is set (e.g. for bpmn process task it is null)
    
    Specified by:
    
    getSubScopeId in interface TaskInfo
  - setSubScopeId
```
public void setSubScopeId(String subScopeId)
```
    Specified by:
    
    setSubScopeId in interface TaskEntity
  - getScopeType
```
public String getScopeType()
```
    Description copied from interface: TaskInfo
    
    Reference to a scope type or null if none is set (e.g. for bpmn process task it is null)
    
    Specified by:
    
    getScopeType in interface TaskInfo
  - setScopeType
```
public void setScopeType(String scopeType)
```
    Specified by:
    
    setScopeType in interface TaskEntity
  - getScopeDefinitionId
```
public String getScopeDefinitionId()
```
    Description copied from interface: TaskInfo
    
    Reference to a scope definition identifier or null if none is set (e.g. for bpmn process task it is null)
    
    Specified by:
    
    getScopeDefinitionId in interface TaskInfo
  - setScopeDefinitionId
```
public void setScopeDefinitionId(String scopeDefinitionId)
```
    Specified by:
    
    setScopeDefinitionId in interface TaskEntity
  - setPropagatedStageInstanceId
```
public void setPropagatedStageInstanceId(String propagatedStageInstanceId)
```
    Specified by:
    
    setPropagatedStageInstanceId in interface TaskEntity
  - getPropagatedStageInstanceId
```
public String getPropagatedStageInstanceId()
```
    Description copied from interface: TaskInfo
    
    If this task runs in the context of a case and stage, this method returns it's closest parent stage instance id (the stage plan item instance id to be precise). Even if the direct parent of the task is a process which itself might have been created out of a process task of a case, its stage instance is reflected in the task.
    
    Specified by:
    
    getPropagatedStageInstanceId in interface TaskInfo
    
    Returns:
    
    the stage instance id this task belongs to or null, if this task is not part of a case at all or is not a child element of a stage
  - getAssignee
```
public String getAssignee()
```
    Description copied from interface: TaskInfo
    
    The user id of the person to which this task is delegated.
    
    Specified by:
    
    getAssignee in interface TaskInfo
    
    Specified by:
    
    getAssignee in interface DelegateTask
  - getOriginalAssignee
```
public String getOriginalAssignee()
```
  - getTaskDefinitionKey
```
public String getTaskDefinitionKey()
```
    Description copied from interface: TaskInfo
    
    The id of the activity in the process defining this task or null if this is not related to a process
    
    Specified by:
    
    getTaskDefinitionKey in interface TaskInfo
    
    Specified by:
    
    getTaskDefinitionKey in interface DelegateTask
  - setTaskDefinitionKey
```
public void setTaskDefinitionKey(String taskDefinitionKey)
```
    Specified by:
    
    setTaskDefinitionKey in interface TaskEntity
  - getEventName
```
public String getEventName()
```
    Description copied from interface: DelegateTask
    
    Returns the event name which triggered the task listener to fire for this task.
    
    Specified by:
    
    getEventName in interface DelegateTask
  - setEventName
```
public void setEventName(String eventName)
```
    Specified by:
    
    setEventName in interface TaskEntity
  - getEventHandlerId
```
public String getEventHandlerId()
```
    Description copied from interface: DelegateTask
    
    Returns the event handler identifier which triggered the task listener to fire for this task.
    
    Specified by:
    
    getEventHandlerId in interface DelegateTask
  - setEventHandlerId
```
public void setEventHandlerId(String eventHandlerId)
```
    Specified by:
    
    setEventHandlerId in interface TaskEntity
  - setExecutionId
```
public void setExecutionId(String executionId)
```
    Specified by:
    
    setExecutionId in interface TaskEntity
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
    Specified by:
    
    setProcessInstanceId in interface TaskEntity
  - getOwner
```
public String getOwner()
```
    Description copied from interface: TaskInfo
    
    The user id of the person that is responsible for this task.
    
    Specified by:
    
    getOwner in interface TaskInfo
    
    Specified by:
    
    getOwner in interface DelegateTask
  - getDelegationState
```
public DelegationState getDelegationState()
```
    Description copied from interface: Task
    
    The current DelegationState for this task.
    
    Specified by:
    
    getDelegationState in interface Task
    
    Specified by:
    
    getDelegationState in interface DelegateTask
  - addCandidateUser
```
public void addCandidateUser(String userId)
```
    Description copied from interface: DelegateTask
    
    Adds the given user as a candidate user to this task.
    
    Specified by:
    
    addCandidateUser in interface DelegateTask
  - addCandidateUsers
```
public void addCandidateUsers(Collection<String> candidateUsers)
```
    Description copied from interface: DelegateTask
    
    Adds multiple users as candidate user to this task.
    
    Specified by:
    
    addCandidateUsers in interface DelegateTask
  - addCandidateGroup
```
public void addCandidateGroup(String groupId)
```
    Description copied from interface: DelegateTask
    
    Adds the given group as candidate group to this task
    
    Specified by:
    
    addCandidateGroup in interface DelegateTask
  - addCandidateGroups
```
public void addCandidateGroups(Collection<String> candidateGroups)
```
    Description copied from interface: DelegateTask
    
    Adds multiple groups as candidate group to this task.
    
    Specified by:
    
    addCandidateGroups in interface DelegateTask
  - convertToIdentityLinks
```
protected List<IdentityLink> convertToIdentityLinks(List<IdentityLinkEntity> identityLinks)
```
  - getTaskAssignmentManager
```
protected InternalTaskAssignmentManager getTaskAssignmentManager()
```
  - getTaskServiceConfiguration
```
protected TaskServiceConfiguration getTaskServiceConfiguration()
```
  - getIdentityLinkServiceConfiguration
```
protected IdentityLinkServiceConfiguration getIdentityLinkServiceConfiguration()
```
  - getVariableServiceConfiguration
```
protected VariableServiceConfiguration getVariableServiceConfiguration()
```
    Specified by:
    
    getVariableServiceConfiguration in class VariableScopeImpl
  - getTaskEngineConfiguration
```
protected AbstractEngineConfiguration getTaskEngineConfiguration()
```
  - setDelegationState
```
public void setDelegationState(DelegationState delegationState)
```
    Description copied from interface: Task
    
    The current DelegationState for this task.
    
    Specified by:
    
    setDelegationState in interface Task
  - getDelegationStateString
```
public String getDelegationStateString()
```
  - setDelegationStateString
```
public void setDelegationStateString(String delegationStateString)
```
  - isDeleted
```
public boolean isDeleted()
```
    Specified by:
    
    isDeleted in interface Entity
    
    Overrides:
    
    isDeleted in class AbstractEntity
  - setDeleted
```
public void setDeleted(boolean isDeleted)
```
    Specified by:
    
    setDeleted in interface Entity
    
    Overrides:
    
    setDeleted in class AbstractEntity
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface TaskEntity
  - setCanceled
```
public void setCanceled(boolean isCanceled)
```
    Specified by:
    
    setCanceled in interface TaskEntity
  - getParentTaskId
```
public String getParentTaskId()
```
    Description copied from interface: TaskInfo
    
    The parent task for which this task is a subtask
    
    Specified by:
    
    getParentTaskId in interface TaskInfo
  - getVariableInstanceEntities
```
public Map<String,VariableInstanceEntity> getVariableInstanceEntities()
```
    Specified by:
    
    getVariableInstanceEntities in interface TaskEntity
    
    Overrides:
    
    getVariableInstanceEntities in class VariableScopeImpl
  - getSuspensionState
```
public int getSuspensionState()
```
    Specified by:
    
    getSuspensionState in interface TaskEntity
  - setSuspensionState
```
public void setSuspensionState(int suspensionState)
```
    Specified by:
    
    setSuspensionState in interface TaskEntity
  - getCategory
```
public String getCategory()
```
    Description copied from interface: TaskInfo
    
    The category of the task. This is an optional field and allows to 'tag' tasks as belonging to a certain category.
    
    Specified by:
    
    getCategory in interface TaskInfo
    
    Specified by:
    
    getCategory in interface DelegateTask
  - isSuspended
```
public boolean isSuspended()
```
    Description copied from interface: Task
    
    Indicates whether this task is suspended or not.
    
    Specified by:
    
    isSuspended in interface Task
    
    Specified by:
    
    isSuspended in interface DelegateTask
  - getTaskLocalVariables
```
public Map<String,Object> getTaskLocalVariables()
```
    Description copied from interface: TaskInfo
    
    Returns the local task variables if requested in the task query
    
    Specified by:
    
    getTaskLocalVariables in interface TaskInfo
  - getProcessVariables
```
public Map<String,Object> getProcessVariables()
```
    Description copied from interface: TaskInfo
    
    Returns the process variables if requested in the task query
    
    Specified by:
    
    getProcessVariables in interface TaskInfo
  - getTenantId
```
public String getTenantId()
```
    Description copied from interface: TaskInfo
    
    The tenant identifier of this task
    
    Specified by:
    
    getTenantId in interface VariableContainer
    
    Specified by:
    
    getTenantId in interface TaskInfo
    
    Specified by:
    
    getTenantId in interface DelegateTask
  - setTenantId
```
public void setTenantId(String tenantId)
```
    Description copied from interface: Task
    
    Change the tenantId of the task
    
    Specified by:
    
    setTenantId in interface Task
  - getQueryVariables
```
public List<VariableInstanceEntity> getQueryVariables()
```
    Specified by:
    
    getQueryVariables in interface TaskEntity
  - setQueryVariables
```
public void setQueryVariables(List<VariableInstanceEntity> queryVariables)
```
  - getQueryIdentityLinks
```
public List<IdentityLinkEntity> getQueryIdentityLinks()
```
  - setQueryIdentityLinks
```
public void setQueryIdentityLinks(List<IdentityLinkEntity> identityLinks)
```
  - getClaimTime
```
public Date getClaimTime()
```
    Description copied from interface: TaskInfo
    
    The claim time of this task
    
    Specified by:
    
    getClaimTime in interface TaskInfo
  - setClaimTime
```
public void setClaimTime(Date claimTime)
```
    Specified by:
    
    setClaimTime in interface TaskEntity
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isCountEnabled
```
public boolean isCountEnabled()
```
    Specified by:
    
    isCountEnabled in interface CountingTaskEntity
  - getIsCountEnabled
```
public boolean getIsCountEnabled()
```
  - setCountEnabled
```
public void setCountEnabled(boolean isCountEnabled)
```
    Specified by:
    
    setCountEnabled in interface CountingTaskEntity
  - setIsCountEnabled
```
public void setIsCountEnabled(boolean isCountEnabled)
```
  - setVariableCount
```
public void setVariableCount(int variableCount)
```
    Specified by:
    
    setVariableCount in interface CountingTaskEntity
  - getVariableCount
```
public int getVariableCount()
```
    Specified by:
    
    getVariableCount in interface CountingTaskEntity
  - setIdentityLinkCount
```
public void setIdentityLinkCount(int identityLinkCount)
```
    Specified by:
    
    setIdentityLinkCount in interface CountingTaskEntity
  - getIdentityLinkCount
```
public int getIdentityLinkCount()
```
    Specified by:
    
    getIdentityLinkCount in interface CountingTaskEntity
  - getSubTaskCount
```
public int getSubTaskCount()
```
    Specified by:
    
    getSubTaskCount in interface CountingTaskEntity
  - setSubTaskCount
```
public void setSubTaskCount(int subTaskCount)
```
    Specified by:
    
    setSubTaskCount in interface CountingTaskEntity

Class TaskEntityImpl

Field Summary

Fields inherited from class org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Fields inherited from interface org.flowable.task.api.Task

Constructor Summary

Method Summary

Methods inherited from class org.flowable.task.service.impl.persistence.entity.AbstractTaskServiceVariableScopeEntity

Methods inherited from class org.flowable.variable.service.impl.persistence.entity.VariableScopeImpl

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.task.api.TaskInfo

Methods inherited from interface org.flowable.task.service.delegate.DelegateTask

Methods inherited from interface org.flowable.variable.api.delegate.VariableScope

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

Field Detail

DELETE_REASON_COMPLETED

DELETE_REASON_DELETED

owner

assigneeUpdatedCount

originalAssignee

assignee

delegationState

parentTaskId

name

localizedName

description

localizedDescription

priority

createTime

dueDate

suspensionState

category

isIdentityLinksInitialized

taskIdentityLinkEntities

executionId

processInstanceId

processDefinitionId

taskDefinitionId

scopeId

subScopeId

scopeType

scopeDefinitionId

propagatedStageInstanceId

taskDefinitionKey

formKey

isCanceled

variableCount

identityLinkCount

subTaskCount

claimTime

tenantId

eventName

eventHandlerId

queryVariables

queryIdentityLinks

forcedUpdate

Constructor Detail

TaskEntityImpl

Method Detail

getPersistentState

forceUpdate

getParentVariableScope

initializeVariableInstanceBackPointer

addLoggingSessionInfo

loadVariableInstances

createVariableInstance

deleteVariableInstanceForExplicitUserCall

getCandidates

getIdentityLinks

setName

setDescription

setAssignee

setAssigneeValue

setOwner

setOwnerValue

setDueDate

setPriority

setCategory