Package org.flowable.cmmn.engine.impl
Class CmmnTaskServiceImpl
java.lang.Object
org.flowable.common.engine.impl.service.CommonServiceImpl<C>
org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CmmnEngineConfiguration>
org.flowable.cmmn.engine.impl.CmmnTaskServiceImpl
- All Implemented Interfaces:
CmmnTaskService
public class CmmnTaskServiceImpl
extends CommonEngineServiceImpl<CmmnEngineConfiguration>
implements CmmnTaskService
- Author:
- Joram Barrez
-
Field Summary
Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl
commandExecutor
Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl
configuration
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateTask
(String taskId, String userId) Activates the task.void
addGroupIdentityLink
(String taskId, String groupId, String identityLinkType) Involves a group with a task.void
addUserIdentityLink
(String taskId, String userId, String identityLinkType) Involves a user with a task.void
bulkSaveTasks
(Collection<Task> taskList) void
Claim responsibility for a task: the given user is made assignee for the task.void
void
void
void
complete
(String taskId, String userId, Map<String, Object> variables, Map<String, Object> transientVariables) void
void
void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables) void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables, boolean localScope) void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables, Map<String, Object> transientVariables) void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables) void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables, boolean localScope) void
completeTaskWithForm
(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables, Map<String, Object> transientVariables) Create a builder for the taskCreate a completion builder for the taskvoid
delegateTask
(String taskId, String userId) Delegates the task to another user.void
deleteGroupIdentityLink
(String taskId, String groupId, String identityLinkType) Removes the association between a group and a task for the given identityLinkType.void
deleteTask
(String taskId) Deletes the given task, not deleting historic information that is related to this task.void
deleteTask
(String taskId, boolean cascade) Deletes the given task.void
deleteTask
(String taskId, String deleteReason) Deletes the given task, not deleting historic information that is related to this task..void
deleteTasks
(Collection<String> taskIds) Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.void
deleteTasks
(Collection<String> taskIds, boolean cascade) Deletes all tasks of the given collection.void
deleteTasks
(Collection<String> taskIds, String deleteReason) Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.void
deleteUserIdentityLink
(String taskId, String userId, String identityLinkType) Removes the association between a user and a task for the given identityLinkType.getIdentityLinksForTask
(String taskId) Retrieves theIdentityLink
s associated with the given task.getSubTasks
(String parentTaskId) The list of subtasks for this parent taskgetTaskFormModel
(String taskId) getTaskFormModel
(String taskId, boolean ignoreVariables) getVariable
(String taskId, String variableName) get a variables and search in the task scope and if available also the execution scopes.<T> T
getVariable
(String taskId, String variableName, Class<T> variableClass) get a variables and search in the task scope and if available also the execution scopes.getVariableInstance
(String taskId, String variableName) The variable.getVariableInstanceLocal
(String taskId, String variableName) The variable for a task.getVariableInstances
(String taskId) All variables visible from the given task scope (including parent scopes).getVariableInstances
(String taskId, Collection<String> variableNames) The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).getVariableInstancesLocal
(String taskId) All variable values that are defined in the task scope, without taking outer scopes into account.getVariableInstancesLocal
(String taskId, Collection<String> variableNames) The variable values for all given variableNames that are defined in the given task's scope.getVariableInstancesLocalByTaskIds
(Set<String> taskIds) get all variables and search only in the task scope.getVariableLocal
(String taskId, String variableName) checks whether or not the task has a variable defined with the given name.<T> T
getVariableLocal
(String taskId, String variableName, Class<T> variableClass) checks whether or not the task has a variable defined with the given name.getVariables
(String taskId) get all variables and search in the task scope and if available also the execution scopes.getVariables
(String taskId, Collection<String> variableNames) get values for all given variableNames and search only in the task scope.getVariablesLocal
(String taskId) get all variables and search only in the task scope.getVariablesLocal
(String taskId, Collection<String> variableNames) get a variable on a taskboolean
hasVariable
(String taskId, String variableName) checks whether or not the task has a variable defined with the given name, in the task scope and if available also the execution scopes.boolean
hasVariableLocal
(String taskId, String variableName) checks whether or not the task has a variable defined with the given name, local task scope only.newTask()
void
removeVariable
(String taskId, String variableName) Removes the variable from the task.void
removeVariableLocal
(String taskId, String variableName) Removes the variable from the task (not considering parent scopes).void
removeVariables
(String taskId, Collection<String> variableNames) Removes all variables in the given collection from the task.void
removeVariablesLocal
(String taskId, Collection<String> variableNames) Removes all variables in the given collection from the task (not considering parent scopes).void
resolveTask
(String taskId) Marks that the assignee is done with this task and that it can be send back to the owner.void
resolveTask
(String taskId, Map<String, Object> variables) Marks that the assignee is done with this task providing the required variables and that it can be sent back to the owner.void
Similar toCmmnTaskService.resolveTask(String, Map)
, but allows to set transient variables too.void
void
setAssignee
(String taskId, String userId) Changes the assignee of the given task to the given userId.void
setDueDate
(String taskId, Date dueDate) Changes the due date of the taskvoid
Transfers ownership of this task to another user.void
setPriority
(String taskId, int priority) Changes the priority of the task.void
setVariable
(String taskId, String variableName, Object value) set variable on a task.void
setVariableLocal
(String taskId, String variableName, Object value) set variable on a task.void
setVariables
(String taskId, Map<String, ? extends Object> variables) set variables on a task.void
setVariablesLocal
(String taskId, Map<String, ? extends Object> variables) set variables on a task.void
startProgress
(String taskId, String userId) Starts the progress on the task.void
suspendTask
(String taskId, String userId) Suspends the task.void
A shortcut toCmmnTaskService.claim(java.lang.String, java.lang.String)
with null user in order to unclaim the taskMethods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl
getCommandExecutor, setCommandExecutor
Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl
getConfiguration
-
Constructor Details
-
CmmnTaskServiceImpl
-
-
Method Details
-
newTask
- Specified by:
newTask
in interfaceCmmnTaskService
-
newTask
- Specified by:
newTask
in interfaceCmmnTaskService
-
saveTask
- Specified by:
saveTask
in interfaceCmmnTaskService
-
bulkSaveTasks
- Specified by:
bulkSaveTasks
in interfaceCmmnTaskService
-
claim
Description copied from interface:CmmnTaskService
Claim responsibility for a task: the given user is made assignee for the task. The difference withCmmnTaskService.setAssignee(String, String)
is that here a check is done if the task already has a user assigned to it. No check is done whether the user is known by the identity component.- Specified by:
claim
in interfaceCmmnTaskService
- Parameters:
taskId
- task to claim, cannot be null.userId
- user that claims the task. When userId is null the task is unclaimed, assigned to no one.
-
unclaim
Description copied from interface:CmmnTaskService
A shortcut toCmmnTaskService.claim(java.lang.String, java.lang.String)
with null user in order to unclaim the task- Specified by:
unclaim
in interfaceCmmnTaskService
- Parameters:
taskId
- task to unclaim, cannot be null.
-
startProgress
Description copied from interface:CmmnTaskService
Starts the progress on the task.- Specified by:
startProgress
in interfaceCmmnTaskService
- Parameters:
taskId
- task to start progress, cannot be null.userId
- user that starts progress for the task.
-
suspendTask
Description copied from interface:CmmnTaskService
Suspends the task. No check is done whether the user is known by the identity component.- Specified by:
suspendTask
in interfaceCmmnTaskService
- Parameters:
taskId
- task to suspend, cannot be null.userId
- user that suspends the task.
-
activateTask
Description copied from interface:CmmnTaskService
Activates the task. No check is done whether the user is known by the identity component.- Specified by:
activateTask
in interfaceCmmnTaskService
- Parameters:
taskId
- task to activate, cannot be null.userId
- user that activates the task.
-
complete
- Specified by:
complete
in interfaceCmmnTaskService
-
complete
- Specified by:
complete
in interfaceCmmnTaskService
-
complete
- Specified by:
complete
in interfaceCmmnTaskService
-
complete
- Specified by:
complete
in interfaceCmmnTaskService
-
complete
public void complete(String taskId, Map<String, Object> variables, Map<String, Object> transientVariables) - Specified by:
complete
in interfaceCmmnTaskService
-
complete
public void complete(String taskId, String userId, Map<String, Object> variables, Map<String, Object> transientVariables) - Specified by:
complete
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables, Map<String, Object> transientVariables) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables, Map<String, Object> transientVariables) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String, Object> variables, boolean localScope) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
completeTaskWithForm
public void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, String userId, Map<String, Object> variables, boolean localScope) - Specified by:
completeTaskWithForm
in interfaceCmmnTaskService
-
createTaskCompletionBuilder
Description copied from interface:CmmnTaskService
Create a completion builder for the task- Specified by:
createTaskCompletionBuilder
in interfaceCmmnTaskService
- Returns:
- task completion builder
-
delegateTask
Description copied from interface:CmmnTaskService
Delegates the task to another user. This means that the assignee is set and the delegation state is set toDelegationState.PENDING
. If no owner is set on the task, the owner is set to the current assignee of the task.- Specified by:
delegateTask
in interfaceCmmnTaskService
- Parameters:
taskId
- The id of the task that will be delegated.userId
- The id of the user that will be set as assignee.
-
resolveTask
Description copied from interface:CmmnTaskService
Marks that the assignee is done with this task and that it can be send back to the owner. Can only be called when this task isDelegationState.PENDING
delegation. After this method returns, thedelegationState
is set toDelegationState.RESOLVED
.- Specified by:
resolveTask
in interfaceCmmnTaskService
- Parameters:
taskId
- the id of the task to resolve, cannot be null.
-
resolveTask
Description copied from interface:CmmnTaskService
Marks that the assignee is done with this task providing the required variables and that it can be sent back to the owner. Can only be called when this task isDelegationState.PENDING
delegation. After this method returns, thedelegationState
is set toDelegationState.RESOLVED
.- Specified by:
resolveTask
in interfaceCmmnTaskService
variables
- When no task exists with the given id.
-
resolveTask
public void resolveTask(String taskId, Map<String, Object> variables, Map<String, Object> transientVariables) Description copied from interface:CmmnTaskService
Similar toCmmnTaskService.resolveTask(String, Map)
, but allows to set transient variables too.- Specified by:
resolveTask
in interfaceCmmnTaskService
-
deleteTask
Description copied from interface:CmmnTaskService
Deletes the given task, not deleting historic information that is related to this task.- Specified by:
deleteTask
in interfaceCmmnTaskService
- Parameters:
taskId
- The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.
-
deleteTasks
Description copied from interface:CmmnTaskService
Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasks
in interfaceCmmnTaskService
- Parameters:
taskIds
- The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.
-
deleteTask
Description copied from interface:CmmnTaskService
Deletes the given task.- Specified by:
deleteTask
in interfaceCmmnTaskService
- Parameters:
taskId
- The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.cascade
- If cascade is true, also the historic information related to this task is deleted.
-
deleteTasks
Description copied from interface:CmmnTaskService
Deletes all tasks of the given collection.- Specified by:
deleteTasks
in interfaceCmmnTaskService
- Parameters:
taskIds
- The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.cascade
- If cascade is true, also the historic information related to this task is deleted.
-
deleteTask
Description copied from interface:CmmnTaskService
Deletes the given task, not deleting historic information that is related to this task..- Specified by:
deleteTask
in interfaceCmmnTaskService
- Parameters:
taskId
- The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.deleteReason
- reason the task is deleted. Is recorded in history, if enabled.
-
deleteTasks
Description copied from interface:CmmnTaskService
Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasks
in interfaceCmmnTaskService
- Parameters:
taskIds
- The id's of the tasks that will be deleted, cannot be null. All id's in the list that don't have an existing task will be ignored.deleteReason
- reason the task is deleted. Is recorded in history, if enabled.
-
getTaskFormModel
- Specified by:
getTaskFormModel
in interfaceCmmnTaskService
-
getTaskFormModel
- Specified by:
getTaskFormModel
in interfaceCmmnTaskService
-
setPriority
Description copied from interface:CmmnTaskService
Changes the priority of the task. Authorization: actual owner / business admin- Specified by:
setPriority
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.priority
- the new priority for the task.
-
setDueDate
Description copied from interface:CmmnTaskService
Changes the due date of the task- Specified by:
setDueDate
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.dueDate
- the new due date for the task
-
createTaskQuery
- Specified by:
createTaskQuery
in interfaceCmmnTaskService
-
getSubTasks
Description copied from interface:CmmnTaskService
The list of subtasks for this parent task- Specified by:
getSubTasks
in interfaceCmmnTaskService
-
getVariables
Description copied from interface:CmmnTaskService
get all variables and search in the task scope and if available also the execution scopes. If you have many variables and you only need a few, consider usingCmmnTaskService.getVariables(String, Collection)
for better performance.- Specified by:
getVariables
in interfaceCmmnTaskService
-
getVariablesLocal
Description copied from interface:CmmnTaskService
get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider usingCmmnTaskService.getVariablesLocal(String, Collection)
for better performance.- Specified by:
getVariablesLocal
in interfaceCmmnTaskService
-
getVariables
Description copied from interface:CmmnTaskService
get values for all given variableNames and search only in the task scope.- Specified by:
getVariables
in interfaceCmmnTaskService
-
getVariablesLocal
Description copied from interface:CmmnTaskService
get a variable on a task- Specified by:
getVariablesLocal
in interfaceCmmnTaskService
-
getVariable
Description copied from interface:CmmnTaskService
get a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariable
in interfaceCmmnTaskService
-
getVariable
Description copied from interface:CmmnTaskService
get a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariable
in interfaceCmmnTaskService
-
hasVariable
Description copied from interface:CmmnTaskService
checks whether or not the task has a variable defined with the given name, in the task scope and if available also the execution scopes.- Specified by:
hasVariable
in interfaceCmmnTaskService
-
getVariableLocal
Description copied from interface:CmmnTaskService
checks whether or not the task has a variable defined with the given name.- Specified by:
getVariableLocal
in interfaceCmmnTaskService
-
getVariableLocal
Description copied from interface:CmmnTaskService
checks whether or not the task has a variable defined with the given name.- Specified by:
getVariableLocal
in interfaceCmmnTaskService
-
getVariableInstancesLocalByTaskIds
Description copied from interface:CmmnTaskService
get all variables and search only in the task scope.- Specified by:
getVariableInstancesLocalByTaskIds
in interfaceCmmnTaskService
-
hasVariableLocal
Description copied from interface:CmmnTaskService
checks whether or not the task has a variable defined with the given name, local task scope only.- Specified by:
hasVariableLocal
in interfaceCmmnTaskService
-
setVariable
Description copied from interface:CmmnTaskService
set variable on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.- Specified by:
setVariable
in interfaceCmmnTaskService
-
setVariableLocal
Description copied from interface:CmmnTaskService
set variable on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariableLocal
in interfaceCmmnTaskService
-
setVariables
Description copied from interface:CmmnTaskService
set variables on a task. If the variable is not already existing, it will be created in the most outer scope. This means the process instance in case this task is related to an execution.- Specified by:
setVariables
in interfaceCmmnTaskService
-
setVariablesLocal
Description copied from interface:CmmnTaskService
set variables on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariablesLocal
in interfaceCmmnTaskService
-
removeVariable
Description copied from interface:CmmnTaskService
Removes the variable from the task. When the variable does not exist, nothing happens.- Specified by:
removeVariable
in interfaceCmmnTaskService
-
removeVariableLocal
Description copied from interface:CmmnTaskService
Removes the variable from the task (not considering parent scopes). When the variable does not exist, nothing happens.- Specified by:
removeVariableLocal
in interfaceCmmnTaskService
-
removeVariables
Description copied from interface:CmmnTaskService
Removes all variables in the given collection from the task. Non existing variable names are simply ignored.- Specified by:
removeVariables
in interfaceCmmnTaskService
-
removeVariablesLocal
Description copied from interface:CmmnTaskService
Removes all variables in the given collection from the task (not considering parent scopes). Non existing variable names are simply ignored.- Specified by:
removeVariablesLocal
in interfaceCmmnTaskService
-
getVariableInstance
Description copied from interface:CmmnTaskService
The variable. Searching for the variable is done in all scopes that are visible to the given task (including parent scopes). Returns null when no variable value is found with the given name.- Specified by:
getVariableInstance
in interfaceCmmnTaskService
- Parameters:
taskId
- id of task, cannot be null.variableName
- name of variable, cannot be null.- Returns:
- the variable or null if the variable is undefined.
-
getVariableInstanceLocal
Description copied from interface:CmmnTaskService
The variable for a task. Returns the variable when it is set for the task (and not searching parent scopes). Returns null when no variable is found with the given name.- Specified by:
getVariableInstanceLocal
in interfaceCmmnTaskService
- Parameters:
taskId
- id of task, cannot be null.variableName
- name of variable, cannot be null.- Returns:
- the variable or null if the variable is undefined.
-
getVariableInstances
Description copied from interface:CmmnTaskService
All variables visible from the given task scope (including parent scopes).- Specified by:
getVariableInstances
in interfaceCmmnTaskService
- Parameters:
taskId
- id of task, cannot be null.- Returns:
- the variable instances or an empty map if no such variables are found.
-
getVariableInstances
public Map<String,VariableInstance> getVariableInstances(String taskId, Collection<String> variableNames) Description copied from interface:CmmnTaskService
The variable values for all given variableNames, takes all variables into account which are visible from the given task scope (including parent scopes).- Specified by:
getVariableInstances
in interfaceCmmnTaskService
- Parameters:
taskId
- id of taskId, cannot be null.variableNames
- the collection of variable names that should be retrieved.- Returns:
- the variables or an empty map if no such variables are found.
-
getVariableInstancesLocal
Description copied from interface:CmmnTaskService
All variable values that are defined in the task scope, without taking outer scopes into account. If you have many task local variables and you only need a few, consider usingCmmnTaskService.getVariableInstancesLocal(String, Collection)
for better performance.- Specified by:
getVariableInstancesLocal
in interfaceCmmnTaskService
- Parameters:
taskId
- id of task, cannot be null.- Returns:
- the variables or an empty map if no such variables are found.
-
getVariableInstancesLocal
public Map<String,VariableInstance> getVariableInstancesLocal(String taskId, Collection<String> variableNames) Description copied from interface:CmmnTaskService
The variable values for all given variableNames that are defined in the given task's scope. (Does not searching parent scopes).- Specified by:
getVariableInstancesLocal
in interfaceCmmnTaskService
- Parameters:
taskId
- id of taskId, cannot be null.variableNames
- the collection of variable names that should be retrieved.- Returns:
- the variables or an empty map if no such variables are found.
-
setAssignee
Description copied from interface:CmmnTaskService
Changes the assignee of the given task to the given userId. No check is done whether the user is known by the identity component.- Specified by:
setAssignee
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user to use as assignee.
-
setOwner
Description copied from interface:CmmnTaskService
Transfers ownership of this task to another user. No check is done whether the user is known by the identity component.- Specified by:
setOwner
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- of the person that is receiving ownership.
-
addUserIdentityLink
Description copied from interface:CmmnTaskService
Involves a user with a task. The type of identity link is defined by the given identityLinkType.- Specified by:
addUserIdentityLink
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user involve, cannot be null.identityLinkType
- type of identityLink, cannot be null.
-
addGroupIdentityLink
Description copied from interface:CmmnTaskService
Involves a group with a task. The type of identityLink is defined by the given identityLink.- Specified by:
addGroupIdentityLink
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.groupId
- id of the group to involve, cannot be null.identityLinkType
- type of identity, cannot be null.
-
deleteGroupIdentityLink
Description copied from interface:CmmnTaskService
Removes the association between a group and a task for the given identityLinkType.- Specified by:
deleteGroupIdentityLink
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.groupId
- id of the group to involve, cannot be null.identityLinkType
- type of identity, cannot be null.
-
deleteUserIdentityLink
Description copied from interface:CmmnTaskService
Removes the association between a user and a task for the given identityLinkType.- Specified by:
deleteUserIdentityLink
in interfaceCmmnTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user involve, cannot be null.identityLinkType
- type of identityLink, cannot be null.
-
getIdentityLinksForTask
Description copied from interface:CmmnTaskService
Retrieves theIdentityLink
s associated with the given task. Such anIdentityLink
informs how a certain identity (eg. group or user) is associated with a certain task (eg. as candidate, assignee, etc.)- Specified by:
getIdentityLinksForTask
in interfaceCmmnTaskService
-
createTaskBuilder
Description copied from interface:CmmnTaskService
Create a builder for the task- Specified by:
createTaskBuilder
in interfaceCmmnTaskService
- Returns:
- task builder
-