Package org.camunda.bpm.engine.impl
Class TaskServiceImpl
java.lang.Object
org.camunda.bpm.engine.impl.ServiceImpl
org.camunda.bpm.engine.impl.TaskServiceImpl
- All Implemented Interfaces:
TaskService
- Author:
- Tom Baeyens, Joram Barrez
-
Field Summary
Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl
commandExecutor
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCandidateGroup
(String taskId, String groupId) Convenience shorthand forTaskService.addGroupIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
void
addCandidateUser
(String taskId, String userId) Convenience shorthand forTaskService.addUserIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
void
addComment
(String taskId, String processInstance, String message) Add a comment to a task and/or process instance.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 responsibility for a task: the given user is madeassignee
for the task.void
Marks a task as done and continues process execution.void
Marks a task as done and continues process execution.completeWithVariablesInReturn
(String taskId, Map<String, Object> variables, boolean deserializeValues) Marks a task as done and continues process execution.createAttachment
(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content) Add a new attachment to a task and/or a process instance and use an input stream to provide the content please use method in runtime service to operate on process instance.createAttachment
(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, String url) Add a new attachment to a task and/or a process instance and use an url as the content please use method in runtime service to operate on process instance Either taskId or processInstanceId has to be providedcreateComment
(String taskId, String processInstance, String message) Creates a comment to a task and/or process instance and returns the comment.Returns a newReturns a newTaskQuery
that can be used to dynamically query tasks.Instantiate a task reportvoid
delegateTask
(String taskId, String userId) Delegates the task to another user.void
deleteAttachment
(String attachmentId) Delete an attachmentvoid
deleteCandidateGroup
(String taskId, String groupId) Convenience shorthand forTaskService.deleteGroupIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
void
deleteCandidateUser
(String taskId, String userId) Convenience shorthand forTaskService.deleteUserIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
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
deleteTaskAttachment
(String taskId, String attachmentId) Delete an attachment to the given task id and attachment idvoid
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.getAttachment
(String attachmentId) Retrieve a particular attachmentgetAttachmentContent
(String attachmentId) Retrieve stream content of a particular attachmentgetIdentityLinksForTask
(String taskId) Retrieves theIdentityLink
s associated with the given task.getProcessInstanceAttachments
(String processInstanceId) The list of attachments associated to a process instancegetProcessInstanceComments
(String processInstanceId) The comments related to the given process instance.getSubTasks
(String parentTaskId) The list of subtasks for this parent taskgetTaskAttachment
(String taskId, String attachmentId) Retrieve a particular attachment to the given task id and attachment idgetTaskAttachmentContent
(String taskId, String attachmentId) Retrieve stream content of a particular attachment to the given task id and attachment idgetTaskAttachments
(String taskId) The list of attachments associated to a taskgetTaskComment
(String taskId, String commentId) Retrieve a particular task commentgetTaskComments
(String taskId) The comments related to the given task.getTaskEvents
(String taskId) The all events related to the given task.getVariable
(String taskId, String variableName) Get a variables and search in the task scope and if available also the execution scopes.getVariableLocal
(String taskId, String variableName) Get a variables and only search in the task scope.<T extends TypedValue>
TgetVariableLocalTyped
(String taskId, String variableName) Get a variables and only search in the task scope.<T extends TypedValue>
TgetVariableLocalTyped
(String taskId, String variableName, boolean deserializeValue) Get a variables and only search in the task scope.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 variableNamesgetVariablesLocal
(String taskId) Get all variables and search only in the task scope.getVariablesLocal
(String taskId, Collection<String> variableNames) Get a variable on a taskgetVariablesLocalTyped
(String taskId) Get all variables and search only in the task scope.getVariablesLocalTyped
(String taskId, boolean deserializeValues) Get all variables and search only in the task scope.getVariablesLocalTyped
(String taskId, Collection<String> variableNames, boolean deserializeValues) Get values for all given variableName.getVariablesTyped
(String taskId) Get all variables and search in the task scope and if available also the execution scopes.getVariablesTyped
(String taskId, boolean deserializeValues) Get all variables and search in the task scope and if available also the execution scopes.getVariablesTyped
(String taskId, Collection<String> variableNames, boolean deserializeValues) Get values for all given variableName<T extends TypedValue>
TgetVariableTyped
(String taskId, String variableName) Get a variables and search in the task scope and if available also the execution scopes.<T extends TypedValue>
TgetVariableTyped
(String taskId, String variableName, boolean deserializeValue) Get a variables and search in the task scope and if available also the execution scopes.protected <T extends TypedValue>
TgetVariableTyped
(String taskId, String variableName, boolean isLocal, boolean deserializeValue) void
handleBpmnError
(String taskId, String errorCode) Signals that a business error appears, which should be handled by the process engine.void
handleBpmnError
(String taskId, String errorCode, String errorMessage) void
void
handleEscalation
(String taskId, String escalationCode) Signals that an escalation appears, which should be handled by the process engine.void
Signals that an escalation appears, which should be handled by the process engine.newTask()
Creates a new task that is not related to any process instance.create a new task with a user defined task idvoid
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) void
resolveTask
(String taskId, Map<String, Object> variables) void
saveAttachment
(Attachment attachment) Update the name and decription of an attachmentvoid
Saves the given task to the persistent data store.void
setAssignee
(String taskId, String userId) Changes the assignee of the given task to the given userId.void
setDescription
(String taskId, String description) Changes the description of the task.void
setDueDate
(String taskId, Date dueDate) Changes the dueDate of the task.void
setFollowUpDate
(String taskId, Date followUpDate) Changes the dueDate of the task.void
Changes the name of the task.void
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.protected void
setVariables
(String taskId, Map<String, ? extends Object> variables, boolean local) void
setVariablesLocal
(String taskId, Map<String, ? extends Object> variables) Set variables on a task.void
updateVariables
(String taskId, Map<String, ? extends Object> modifications, Collection<String> deletions) protected void
updateVariables
(String taskId, Map<String, ? extends Object> modifications, Collection<String> deletions, boolean local) void
updateVariablesLocal
(String taskId, Map<String, ? extends Object> modifications, Collection<String> deletions) Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl
getCommandExecutor, setCommandExecutor
-
Constructor Details
-
TaskServiceImpl
public TaskServiceImpl()
-
-
Method Details
-
newTask
Description copied from interface:TaskService
Creates a new task that is not related to any process instance. The returned task is transient and must be saved withTaskService.saveTask(Task)
'manually'.- Specified by:
newTask
in interfaceTaskService
-
newTask
Description copied from interface:TaskService
create a new task with a user defined task id- Specified by:
newTask
in interfaceTaskService
-
saveTask
Description copied from interface:TaskService
Saves the given task to the persistent data store. If the task is already present in the persistent store, it is updated. After a new task has been saved, the task instance passed into this method is updated with the id of the newly created task.- Specified by:
saveTask
in interfaceTaskService
- Parameters:
task
- the task, cannot be null.
-
deleteTask
Description copied from interface:TaskService
Deletes the given task, not deleting historic information that is related to this task.- Specified by:
deleteTask
in interfaceTaskService
- 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:TaskService
Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasks
in interfaceTaskService
- 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:TaskService
Deletes the given task.- Specified by:
deleteTask
in interfaceTaskService
- 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:TaskService
Deletes all tasks of the given collection.- Specified by:
deleteTasks
in interfaceTaskService
- 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:TaskService
Deletes the given task, not deleting historic information that is related to this task.- Specified by:
deleteTask
in interfaceTaskService
- 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:TaskService
Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasks
in interfaceTaskService
- 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.
-
setAssignee
Description copied from interface:TaskService
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 interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user to use as assignee.
-
setOwner
Description copied from interface:TaskService
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 interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- of the person that is receiving ownership.
-
addCandidateUser
Description copied from interface:TaskService
Convenience shorthand forTaskService.addUserIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
- Specified by:
addCandidateUser
in interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user to use as candidate, cannot be null.
-
addCandidateGroup
Description copied from interface:TaskService
Convenience shorthand forTaskService.addGroupIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
- Specified by:
addCandidateGroup
in interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.groupId
- id of the group to use as candidate, cannot be null.
-
addUserIdentityLink
Description copied from interface:TaskService
Involves a user with a task. The type of identity link is defined by the given identityLinkType.- Specified by:
addUserIdentityLink
in interfaceTaskService
- 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 (@seeIdentityLinkType
).
-
addGroupIdentityLink
Description copied from interface:TaskService
Involves a group with a task. The type of identityLink is defined by the given identityLink.- Specified by:
addGroupIdentityLink
in interfaceTaskService
- 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 (@seeIdentityLinkType
).
-
deleteCandidateGroup
Description copied from interface:TaskService
Convenience shorthand forTaskService.deleteGroupIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
- Specified by:
deleteCandidateGroup
in interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.groupId
- id of the group to use as candidate, cannot be null.
-
deleteCandidateUser
Description copied from interface:TaskService
Convenience shorthand forTaskService.deleteUserIdentityLink(String, String, String)
; with typeIdentityLinkType.CANDIDATE
- Specified by:
deleteCandidateUser
in interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.userId
- id of the user to use as candidate, cannot be null.
-
deleteGroupIdentityLink
Description copied from interface:TaskService
Removes the association between a group and a task for the given identityLinkType.- Specified by:
deleteGroupIdentityLink
in interfaceTaskService
- 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 (@seeIdentityLinkType
).
-
deleteUserIdentityLink
Description copied from interface:TaskService
Removes the association between a user and a task for the given identityLinkType.- Specified by:
deleteUserIdentityLink
in interfaceTaskService
- 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 (@seeIdentityLinkType
).
-
getIdentityLinksForTask
Description copied from interface:TaskService
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 interfaceTaskService
-
claim
Description copied from interface:TaskService
Claim responsibility for a task: the given user is madeassignee
for the task. The difference withTaskService.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 interfaceTaskService
- 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.
-
complete
Description copied from interface:TaskService
Marks a task as done and continues process execution. This method is typically called by a task list user interface after a task form has been submitted by theassignee
.- Specified by:
complete
in interfaceTaskService
- Parameters:
taskId
- the id of the task to complete, cannot be null.
-
complete
Description copied from interface:TaskService
Marks a task as done and continues process execution. This method is typically called by a task list user interface after a task form has been submitted by theassignee
and the required task parameters have been provided.- Specified by:
complete
in interfaceTaskService
- Parameters:
taskId
- the id of the task to complete, cannot be null.variables
- task parameters. May be null or empty.
-
completeWithVariablesInReturn
public VariableMap completeWithVariablesInReturn(String taskId, Map<String, Object> variables, boolean deserializeValues) Description copied from interface:TaskService
Marks a task as done and continues process execution. This method is typically called by a task list user interface after a task form has been submitted by theassignee
and the required task parameters have been provided.- Specified by:
completeWithVariablesInReturn
in interfaceTaskService
- Parameters:
taskId
- the id of the task to complete, cannot be null.variables
- task parameters. May be null or empty.deserializeValues
- if false, returnedSerializableValue
s will not be deserialized (unless they are passed into this method as a deserialized value or if the BPMN process triggers deserialization)- Returns:
- All task variables with their current value
-
delegateTask
Description copied from interface:TaskService
Delegates the task to another user. This means that theassignee
is set and thedelegation state
is set toDelegationState.PENDING
. If no owner is set on the task, the owner is set to the currentassignee
of the task. The new assignee must useTaskService.resolveTask(String)
to report back to the owner. Only the owner cancomplete
the task.- Specified by:
delegateTask
in interfaceTaskService
- 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:TaskService
Marks that theassignee
is done with the taskdelegated
to her and that it can be sent back to theowner
. Can only be called when this task isDelegationState.PENDING
delegation. After this method returns, thedelegation state
is set toDelegationState.RESOLVED
and the task can becompleted
.- Specified by:
resolveTask
in interfaceTaskService
- Parameters:
taskId
- the id of the task to resolve, cannot be null.
-
resolveTask
Description copied from interface:TaskService
Marks that theassignee
is done with the taskdelegated
to her and that it can be sent back to theowner
with the provided variables. Can only be called when this task isDelegationState.PENDING
delegation. After this method returns, thedelegation state
is set toDelegationState.RESOLVED
and the task can becompleted
.- Specified by:
resolveTask
in interfaceTaskService
-
setPriority
Description copied from interface:TaskService
Changes the priority of the task.Authorization: actual owner / business admin
- Specified by:
setPriority
in interfaceTaskService
- Parameters:
taskId
- id of the task, cannot be null.priority
- the new priority for the task.
-
setName
Description copied from interface:TaskService
Changes the name of the task.- Specified by:
setName
in interfaceTaskService
- Parameters:
taskId
- id of the task, not nullname
- the new task name, not null
-
setDescription
Description copied from interface:TaskService
Changes the description of the task.- Specified by:
setDescription
in interfaceTaskService
- Parameters:
taskId
- id of the task, not nulldescription
- the new task description, not null
-
setDueDate
Description copied from interface:TaskService
Changes the dueDate of the task.- Specified by:
setDueDate
in interfaceTaskService
- Parameters:
taskId
- id of the task, not nulldueDate
- the new task dueDate, not null
-
setFollowUpDate
Description copied from interface:TaskService
Changes the dueDate of the task.- Specified by:
setFollowUpDate
in interfaceTaskService
- Parameters:
taskId
- id of the task, not nullfollowUpDate
- the new task followUpDate, not null
-
createTaskQuery
Description copied from interface:TaskService
Returns a newTaskQuery
that can be used to dynamically query tasks.- Specified by:
createTaskQuery
in interfaceTaskService
-
createNativeTaskQuery
Description copied from interface:TaskService
Returns a new- Specified by:
createNativeTaskQuery
in interfaceTaskService
-
getVariables
Description copied from interface:TaskService
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 usingTaskService.getVariables(String, Collection)
for better performance.- Specified by:
getVariables
in interfaceTaskService
-
getVariablesTyped
Description copied from interface:TaskService
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 usingTaskService.getVariables(String, Collection)
for better performance.- Specified by:
getVariablesTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the task
-
getVariablesTyped
Description copied from interface:TaskService
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 usingTaskService.getVariables(String, Collection)
for better performance.- Specified by:
getVariablesTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskdeserializeValues
- if false,SerializableValues
will not be deserialized.
-
getVariablesLocal
Description copied from interface:TaskService
Get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider usingTaskService.getVariablesLocal(String, Collection)
for better performance.- Specified by:
getVariablesLocal
in interfaceTaskService
-
getVariablesLocalTyped
Description copied from interface:TaskService
Get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider usingTaskService.getVariablesLocal(String, Collection)
for better performance.- Specified by:
getVariablesLocalTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the task
-
getVariablesLocalTyped
Description copied from interface:TaskService
Get all variables and search only in the task scope. If you have many task local variables and you only need a few, consider usingTaskService.getVariablesLocal(String, Collection)
for better performance.- Specified by:
getVariablesLocalTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskdeserializeValues
- if false,SerializableValues
will not be deserialized.
-
getVariables
Description copied from interface:TaskService
Get values for all given variableNames- Specified by:
getVariables
in interfaceTaskService
-
getVariablesTyped
public VariableMap getVariablesTyped(String taskId, Collection<String> variableNames, boolean deserializeValues) Description copied from interface:TaskService
Get values for all given variableName- Specified by:
getVariablesTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableNames
- only fetch variables whose names are in the collection.deserializeValues
- if false,SerializableValues
will not be deserialized.
-
getVariablesLocal
Description copied from interface:TaskService
Get a variable on a task- Specified by:
getVariablesLocal
in interfaceTaskService
-
getVariablesLocalTyped
public VariableMap getVariablesLocalTyped(String taskId, Collection<String> variableNames, boolean deserializeValues) Description copied from interface:TaskService
Get values for all given variableName. Only search in the local task scope.- Specified by:
getVariablesLocalTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableNames
- only fetch variables whose names are in the collection.deserializeValues
- if false,SerializableValues
will not be deserialized.
-
getVariable
Description copied from interface:TaskService
Get a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariable
in interfaceTaskService
-
getVariableLocal
Description copied from interface:TaskService
Get a variables and only search in the task scope.- Specified by:
getVariableLocal
in interfaceTaskService
-
getVariableTyped
Description copied from interface:TaskService
Get a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariableTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableName
- the name of the variable to fetch- Returns:
- the TypedValue for the variable or 'null' in case no such variable exists.
-
getVariableTyped
public <T extends TypedValue> T getVariableTyped(String taskId, String variableName, boolean deserializeValue) Description copied from interface:TaskService
Get a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariableTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableName
- the name of the variable to fetchdeserializeValue
- if false a,SerializableValue
will not be deserialized.- Returns:
- the TypedValue for the variable or 'null' in case no such variable exists.
-
getVariableLocalTyped
Description copied from interface:TaskService
Get a variables and only search in the task scope.- Specified by:
getVariableLocalTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableName
- the name of the variable to fetch- Returns:
- the TypedValue for the variable or 'null' in case no such variable exists.
-
getVariableLocalTyped
public <T extends TypedValue> T getVariableLocalTyped(String taskId, String variableName, boolean deserializeValue) Description copied from interface:TaskService
Get a variables and only search in the task scope.- Specified by:
getVariableLocalTyped
in interfaceTaskService
- Parameters:
taskId
- the id of the taskvariableName
- the name of the variable to fetchdeserializeValue
- if false a,SerializableValue
will not be deserialized.- Returns:
- the TypedValue for the variable or 'null' in case no such variable exists.
-
getVariableTyped
protected <T extends TypedValue> T getVariableTyped(String taskId, String variableName, boolean isLocal, boolean deserializeValue) -
setVariable
Description copied from interface:TaskService
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 interfaceTaskService
-
setVariableLocal
Description copied from interface:TaskService
Set variable on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariableLocal
in interfaceTaskService
-
setVariables
Description copied from interface:TaskService
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 interfaceTaskService
-
setVariablesLocal
Description copied from interface:TaskService
Set variables on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariablesLocal
in interfaceTaskService
-
setVariables
-
updateVariablesLocal
-
updateVariables
-
updateVariables
-
removeVariable
Description copied from interface:TaskService
Removes the variable from the task. When the variable does not exist, nothing happens.- Specified by:
removeVariable
in interfaceTaskService
-
removeVariableLocal
Description copied from interface:TaskService
Removes the variable from the task (not considering parent scopes). When the variable does not exist, nothing happens.- Specified by:
removeVariableLocal
in interfaceTaskService
-
removeVariables
Description copied from interface:TaskService
Removes all variables in the given collection from the task. Non existing variable names are simply ignored.- Specified by:
removeVariables
in interfaceTaskService
-
removeVariablesLocal
Description copied from interface:TaskService
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 interfaceTaskService
-
addComment
Description copied from interface:TaskService
Add a comment to a task and/or process instance.- Specified by:
addComment
in interfaceTaskService
-
createComment
Description copied from interface:TaskService
Creates a comment to a task and/or process instance and returns the comment.- Specified by:
createComment
in interfaceTaskService
-
getTaskComments
Description copied from interface:TaskService
The comments related to the given task.- Specified by:
getTaskComments
in interfaceTaskService
-
getTaskComment
Description copied from interface:TaskService
Retrieve a particular task comment- Specified by:
getTaskComment
in interfaceTaskService
-
getTaskEvents
Description copied from interface:TaskService
The all events related to the given task.
As of Camunda Platform 7.4 task events are only written in context of a logged in user. This behavior can be toggled in the process engine configuration using the property
legacyUserOperationLog
(default false). To restore the engine's previous behavior, set the flag totrue
.- Specified by:
getTaskEvents
in interfaceTaskService
- See Also:
-
getProcessInstanceComments
Description copied from interface:TaskService
The comments related to the given process instance.- Specified by:
getProcessInstanceComments
in interfaceTaskService
-
createAttachment
public Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content) Description copied from interface:TaskService
Add a new attachment to a task and/or a process instance and use an input stream to provide the content please use method in runtime service to operate on process instance. Either taskId or processInstanceId has to be provided- Specified by:
createAttachment
in interfaceTaskService
- Parameters:
attachmentType
- - name of the attachment, can be nulltaskId
- - task that should have an attachmentprocessInstanceId
- - id of a process to use if task id is nullattachmentName
- - name of the attachment, can be nullattachmentDescription
- - full text description, can be nullcontent
- - byte array with content of attachment
-
createAttachment
public Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, String url) Description copied from interface:TaskService
Add a new attachment to a task and/or a process instance and use an url as the content please use method in runtime service to operate on process instance Either taskId or processInstanceId has to be provided- Specified by:
createAttachment
in interfaceTaskService
- Parameters:
attachmentType
- - name of the attachment, can be nulltaskId
- - task that should have an attachmentprocessInstanceId
- - id of a process to use if task id is nullattachmentName
- - name of the attachment, can be nullattachmentDescription
- - full text description, can be nullurl
- - url of the attachment, can be null
-
getAttachmentContent
Description copied from interface:TaskService
Retrieve stream content of a particular attachment- Specified by:
getAttachmentContent
in interfaceTaskService
-
getTaskAttachmentContent
Description copied from interface:TaskService
Retrieve stream content of a particular attachment to the given task id and attachment id- Specified by:
getTaskAttachmentContent
in interfaceTaskService
-
deleteAttachment
Description copied from interface:TaskService
Delete an attachment- Specified by:
deleteAttachment
in interfaceTaskService
-
deleteTaskAttachment
Description copied from interface:TaskService
Delete an attachment to the given task id and attachment id- Specified by:
deleteTaskAttachment
in interfaceTaskService
-
getAttachment
Description copied from interface:TaskService
Retrieve a particular attachment- Specified by:
getAttachment
in interfaceTaskService
-
getTaskAttachment
Description copied from interface:TaskService
Retrieve a particular attachment to the given task id and attachment id- Specified by:
getTaskAttachment
in interfaceTaskService
-
getTaskAttachments
Description copied from interface:TaskService
The list of attachments associated to a task- Specified by:
getTaskAttachments
in interfaceTaskService
-
getProcessInstanceAttachments
Description copied from interface:TaskService
The list of attachments associated to a process instance- Specified by:
getProcessInstanceAttachments
in interfaceTaskService
-
saveAttachment
Description copied from interface:TaskService
Update the name and decription of an attachment- Specified by:
saveAttachment
in interfaceTaskService
-
getSubTasks
Description copied from interface:TaskService
The list of subtasks for this parent task- Specified by:
getSubTasks
in interfaceTaskService
-
createTaskReport
Description copied from interface:TaskService
Instantiate a task report- Specified by:
createTaskReport
in interfaceTaskService
-
handleBpmnError
Description copied from interface:TaskService
Signals that a business error appears, which should be handled by the process engine.- Specified by:
handleBpmnError
in interfaceTaskService
- Parameters:
taskId
- the id of an existing active taskerrorCode
- the error code of the corresponding bmpn error
-
handleBpmnError
- Specified by:
handleBpmnError
in interfaceTaskService
- Parameters:
taskId
- the id of an existing active taskerrorCode
- the error code of the corresponding bmpn errorerrorMessage
- the error message of the corresponding bmpn error- See Also:
-
handleBpmnError
public void handleBpmnError(String taskId, String errorCode, String errorMessage, Map<String, Object> variables) - Specified by:
handleBpmnError
in interfaceTaskService
- Parameters:
taskId
- the id of an existing active taskerrorCode
- the error code of the corresponding bmpn errorerrorMessage
- the error message of the corresponding bmpn errorvariables
- the variables to pass to the execution- See Also:
-
handleEscalation
Description copied from interface:TaskService
Signals that an escalation appears, which should be handled by the process engine.- Specified by:
handleEscalation
in interfaceTaskService
- Parameters:
taskId
- the id of an existing active taskescalationCode
- the escalation code of the corresponding escalation
-
handleEscalation
Description copied from interface:TaskService
Signals that an escalation appears, which should be handled by the process engine.- Specified by:
handleEscalation
in interfaceTaskService
- Parameters:
taskId
- the id of an existing active taskescalationCode
- the escalation code of the corresponding escalationvariables
- the variables to pass to the execution
-