public class CmmnTaskServiceImpl extends CommonEngineServiceImpl<CmmnEngineConfiguration> implements CmmnTaskService
commandExecutorconfiguration| Constructor and Description |
|---|
CmmnTaskServiceImpl(CmmnEngineConfiguration engineConfiguration) |
| Modifier and Type | Method and Description |
|---|---|
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 |
claim(String taskId,
String userId)
Claim responsibility for a task: the given user is made assignee for the task.
|
void |
complete(String taskId) |
void |
complete(String taskId,
Map<String,Object> variables) |
void |
complete(String taskId,
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) |
TaskBuilder |
createTaskBuilder()
Create a builder for the task
|
TaskQuery |
createTaskQuery() |
void |
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.
|
List<IdentityLink> |
getIdentityLinksForTask(String taskId)
Retrieves the
IdentityLinks associated with the given task. |
List<Task> |
getSubTasks(String parentTaskId)
The list of subtasks for this parent task
|
FormInfo |
getTaskFormModel(String taskId) |
FormInfo |
getTaskFormModel(String taskId,
boolean ignoreVariables) |
Object |
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.
|
VariableInstance |
getVariableInstance(String taskId,
String variableName)
The variable.
|
VariableInstance |
getVariableInstanceLocal(String taskId,
String variableName)
The variable for a task.
|
Map<String,VariableInstance> |
getVariableInstances(String taskId)
All variables visible from the given task scope (including parent scopes).
|
Map<String,VariableInstance> |
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).
|
Map<String,VariableInstance> |
getVariableInstancesLocal(String taskId)
All variable values that are defined in the task scope, without taking outer scopes into account.
|
Map<String,VariableInstance> |
getVariableInstancesLocal(String taskId,
Collection<String> variableNames)
The variable values for all given variableNames that are defined in the given task's scope.
|
List<VariableInstance> |
getVariableInstancesLocalByTaskIds(Set<String> taskIds)
get all variables and search only in the task scope.
|
Object |
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.
|
Map<String,Object> |
getVariables(String taskId)
get all variables and search in the task scope and if available also the execution scopes.
|
Map<String,Object> |
getVariables(String taskId,
Collection<String> variableNames)
get values for all given variableNames and search only in the task scope.
|
Map<String,Object> |
getVariablesLocal(String taskId)
get all variables and search only in the task scope.
|
Map<String,Object> |
getVariablesLocal(String taskId,
Collection<String> variableNames)
get a variable on a task
|
boolean |
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.
|
Task |
newTask() |
Task |
newTask(String taskId) |
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 |
resolveTask(String taskId,
Map<String,Object> variables,
Map<String,Object> transientVariables)
Similar to
CmmnTaskService.resolveTask(String, Map), but allows to set transient variables too. |
void |
saveTask(Task task) |
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 task
|
void |
setOwner(String taskId,
String userId)
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 |
unclaim(String taskId)
A shortcut to
CmmnTaskService.claim(java.lang.String, java.lang.String) with null user in order to unclaim the task |
getCommandExecutor, setCommandExecutorgetConfigurationpublic CmmnTaskServiceImpl(CmmnEngineConfiguration engineConfiguration)
public Task newTask()
newTask in interface CmmnTaskServicepublic Task newTask(String taskId)
newTask in interface CmmnTaskServicepublic void saveTask(Task task)
saveTask in interface CmmnTaskServicepublic void claim(String taskId, String userId)
CmmnTaskServiceCmmnTaskService.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.claim in interface CmmnTaskServicetaskId - task to claim, cannot be null.userId - user that claims the task. When userId is null the task is unclaimed, assigned to no one.public void unclaim(String taskId)
CmmnTaskServiceCmmnTaskService.claim(java.lang.String, java.lang.String) with null user in order to unclaim the taskunclaim in interface CmmnTaskServicetaskId - task to unclaim, cannot be null.public void complete(String taskId)
complete in interface CmmnTaskServicepublic void complete(String taskId, Map<String,Object> variables)
complete in interface CmmnTaskServicepublic void complete(String taskId, Map<String,Object> variables, Map<String,Object> transientVariables)
complete in interface CmmnTaskServicepublic void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables)
completeTaskWithForm in interface CmmnTaskServicepublic void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables, Map<String,Object> transientVariables)
completeTaskWithForm in interface CmmnTaskServicepublic void completeTaskWithForm(String taskId, String formDefinitionId, String outcome, Map<String,Object> variables, boolean localScope)
completeTaskWithForm in interface CmmnTaskServicepublic void delegateTask(String taskId, String userId)
CmmnTaskServiceDelegationState.PENDING. If no owner is set on the task, the owner is set to
the current assignee of the task.delegateTask in interface CmmnTaskServicetaskId - The id of the task that will be delegated.userId - The id of the user that will be set as assignee.public void resolveTask(String taskId)
CmmnTaskServiceDelegationState.PENDING delegation. After this method
returns, the delegationState is set to DelegationState.RESOLVED.resolveTask in interface CmmnTaskServicetaskId - the id of the task to resolve, cannot be null.public void resolveTask(String taskId, Map<String,Object> variables)
CmmnTaskServiceDelegationState.PENDING
delegation. After this method returns, the delegationState is set to DelegationState.RESOLVED.resolveTask in interface CmmnTaskServicevariables - When no task exists with the given id.public void resolveTask(String taskId, Map<String,Object> variables, Map<String,Object> transientVariables)
CmmnTaskServiceCmmnTaskService.resolveTask(String, Map), but allows to set transient variables too.resolveTask in interface CmmnTaskServicepublic void deleteTask(String taskId)
CmmnTaskServicedeleteTask in interface CmmnTaskServicetaskId - The id of the task that will be deleted, cannot be null. If no task exists with the given taskId, the operation is ignored.public void deleteTasks(Collection<String> taskIds)
CmmnTaskServicedeleteTasks in interface CmmnTaskServicetaskIds - 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.public void deleteTask(String taskId, boolean cascade)
CmmnTaskServicedeleteTask in interface CmmnTaskServicetaskId - 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.public void deleteTasks(Collection<String> taskIds, boolean cascade)
CmmnTaskServicedeleteTasks in interface CmmnTaskServicetaskIds - 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.public void deleteTask(String taskId, String deleteReason)
CmmnTaskServicedeleteTask in interface CmmnTaskServicetaskId - 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.public void deleteTasks(Collection<String> taskIds, String deleteReason)
CmmnTaskServicedeleteTasks in interface CmmnTaskServicetaskIds - 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.public FormInfo getTaskFormModel(String taskId)
getTaskFormModel in interface CmmnTaskServicepublic FormInfo getTaskFormModel(String taskId, boolean ignoreVariables)
getTaskFormModel in interface CmmnTaskServicepublic void setPriority(String taskId, int priority)
CmmnTaskServicesetPriority in interface CmmnTaskServicetaskId - id of the task, cannot be null.priority - the new priority for the task.public void setDueDate(String taskId, Date dueDate)
CmmnTaskServicesetDueDate in interface CmmnTaskServicetaskId - id of the task, cannot be null.dueDate - the new due date for the taskpublic TaskQuery createTaskQuery()
createTaskQuery in interface CmmnTaskServicepublic List<Task> getSubTasks(String parentTaskId)
CmmnTaskServicegetSubTasks in interface CmmnTaskServicepublic Map<String,Object> getVariables(String taskId)
CmmnTaskServiceCmmnTaskService.getVariables(String, Collection) for better performance.getVariables in interface CmmnTaskServicepublic Map<String,Object> getVariablesLocal(String taskId)
CmmnTaskServiceCmmnTaskService.getVariablesLocal(String, Collection) for better
performance.getVariablesLocal in interface CmmnTaskServicepublic Map<String,Object> getVariables(String taskId, Collection<String> variableNames)
CmmnTaskServicegetVariables in interface CmmnTaskServicepublic Map<String,Object> getVariablesLocal(String taskId, Collection<String> variableNames)
CmmnTaskServicegetVariablesLocal in interface CmmnTaskServicepublic Object getVariable(String taskId, String variableName)
CmmnTaskServicegetVariable in interface CmmnTaskServicepublic <T> T getVariable(String taskId, String variableName, Class<T> variableClass)
CmmnTaskServicegetVariable in interface CmmnTaskServicepublic boolean hasVariable(String taskId, String variableName)
CmmnTaskServicehasVariable in interface CmmnTaskServicepublic Object getVariableLocal(String taskId, String variableName)
CmmnTaskServicegetVariableLocal in interface CmmnTaskServicepublic <T> T getVariableLocal(String taskId, String variableName, Class<T> variableClass)
CmmnTaskServicegetVariableLocal in interface CmmnTaskServicepublic List<VariableInstance> getVariableInstancesLocalByTaskIds(Set<String> taskIds)
CmmnTaskServicegetVariableInstancesLocalByTaskIds in interface CmmnTaskServicepublic boolean hasVariableLocal(String taskId, String variableName)
CmmnTaskServicehasVariableLocal in interface CmmnTaskServicepublic void setVariable(String taskId, String variableName, Object value)
CmmnTaskServicesetVariable in interface CmmnTaskServicepublic void setVariableLocal(String taskId, String variableName, Object value)
CmmnTaskServicesetVariableLocal in interface CmmnTaskServicepublic void setVariables(String taskId, Map<String,? extends Object> variables)
CmmnTaskServicesetVariables in interface CmmnTaskServicepublic void setVariablesLocal(String taskId, Map<String,? extends Object> variables)
CmmnTaskServicesetVariablesLocal in interface CmmnTaskServicepublic void removeVariable(String taskId, String variableName)
CmmnTaskServiceremoveVariable in interface CmmnTaskServicepublic void removeVariableLocal(String taskId, String variableName)
CmmnTaskServiceremoveVariableLocal in interface CmmnTaskServicepublic void removeVariables(String taskId, Collection<String> variableNames)
CmmnTaskServiceremoveVariables in interface CmmnTaskServicepublic void removeVariablesLocal(String taskId, Collection<String> variableNames)
CmmnTaskServiceremoveVariablesLocal in interface CmmnTaskServicepublic VariableInstance getVariableInstance(String taskId, String variableName)
CmmnTaskServicegetVariableInstance in interface CmmnTaskServicetaskId - id of task, cannot be null.variableName - name of variable, cannot be null.public VariableInstance getVariableInstanceLocal(String taskId, String variableName)
CmmnTaskServicegetVariableInstanceLocal in interface CmmnTaskServicetaskId - id of task, cannot be null.variableName - name of variable, cannot be null.public Map<String,VariableInstance> getVariableInstances(String taskId)
CmmnTaskServicegetVariableInstances in interface CmmnTaskServicetaskId - id of task, cannot be null.public Map<String,VariableInstance> getVariableInstances(String taskId, Collection<String> variableNames)
CmmnTaskServicegetVariableInstances in interface CmmnTaskServicetaskId - id of taskId, cannot be null.variableNames - the collection of variable names that should be retrieved.public Map<String,VariableInstance> getVariableInstancesLocal(String taskId)
CmmnTaskServiceCmmnTaskService.getVariableInstancesLocal(String, Collection) for better performance.getVariableInstancesLocal in interface CmmnTaskServicetaskId - id of task, cannot be null.public Map<String,VariableInstance> getVariableInstancesLocal(String taskId, Collection<String> variableNames)
CmmnTaskServicegetVariableInstancesLocal in interface CmmnTaskServicetaskId - id of taskId, cannot be null.variableNames - the collection of variable names that should be retrieved.public void setAssignee(String taskId, String userId)
CmmnTaskServicesetAssignee in interface CmmnTaskServicetaskId - id of the task, cannot be null.userId - id of the user to use as assignee.public void setOwner(String taskId, String userId)
CmmnTaskServicesetOwner in interface CmmnTaskServicetaskId - id of the task, cannot be null.userId - of the person that is receiving ownership.public void addUserIdentityLink(String taskId, String userId, String identityLinkType)
CmmnTaskServiceaddUserIdentityLink in interface CmmnTaskServicetaskId - id of the task, cannot be null.userId - id of the user involve, cannot be null.identityLinkType - type of identityLink, cannot be null.public void addGroupIdentityLink(String taskId, String groupId, String identityLinkType)
CmmnTaskServiceaddGroupIdentityLink in interface CmmnTaskServicetaskId - id of the task, cannot be null.groupId - id of the group to involve, cannot be null.identityLinkType - type of identity, cannot be null.public void deleteGroupIdentityLink(String taskId, String groupId, String identityLinkType)
CmmnTaskServicedeleteGroupIdentityLink in interface CmmnTaskServicetaskId - id of the task, cannot be null.groupId - id of the group to involve, cannot be null.identityLinkType - type of identity, cannot be null.public void deleteUserIdentityLink(String taskId, String userId, String identityLinkType)
CmmnTaskServicedeleteUserIdentityLink in interface CmmnTaskServicetaskId - id of the task, cannot be null.userId - id of the user involve, cannot be null.identityLinkType - type of identityLink, cannot be null.public List<IdentityLink> getIdentityLinksForTask(String taskId)
CmmnTaskServiceIdentityLinks associated with the given task. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain task (eg. as
candidate, assignee, etc.)getIdentityLinksForTask in interface CmmnTaskServicepublic TaskBuilder createTaskBuilder()
CmmnTaskServicecreateTaskBuilder in interface CmmnTaskServiceCopyright © 2023 Flowable. All rights reserved.