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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCandidateGroup(String taskId, String groupId) Convenience shorthand forTaskService.addGroupIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATEvoidaddCandidateUser(String taskId, String userId) Convenience shorthand forTaskService.addUserIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATEvoidaddComment(String taskId, String processInstance, String message) Add a comment to a task and/or process instance.voidaddGroupIdentityLink(String taskId, String groupId, String identityLinkType) Involves a group with a task.voidaddUserIdentityLink(String taskId, String userId, String identityLinkType) Involves a user with a task.voidClaim responsibility for a task: the given user is madeassigneefor the task.voidMarks a task as done and continues process execution.voidMarks 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 newTaskQuerythat can be used to dynamically query tasks.Instantiate a task reportvoiddelegateTask(String taskId, String userId) Delegates the task to another user.voiddeleteAttachment(String attachmentId) Delete an attachmentvoiddeleteCandidateGroup(String taskId, String groupId) Convenience shorthand forTaskService.deleteGroupIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATEvoiddeleteCandidateUser(String taskId, String userId) Convenience shorthand forTaskService.deleteUserIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATEvoiddeleteGroupIdentityLink(String taskId, String groupId, String identityLinkType) Removes the association between a group and a task for the given identityLinkType.voiddeleteTask(String taskId) Deletes the given task, not deleting historic information that is related to this task.voiddeleteTask(String taskId, boolean cascade) Deletes the given task.voiddeleteTask(String taskId, String deleteReason) Deletes the given task, not deleting historic information that is related to this task.voiddeleteTaskAttachment(String taskId, String attachmentId) Delete an attachment to the given task id and attachment idvoiddeleteTasks(Collection<String> taskIds) Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.voiddeleteTasks(Collection<String> taskIds, boolean cascade) Deletes all tasks of the given collection.voiddeleteTasks(Collection<String> taskIds, String deleteReason) Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.voiddeleteUserIdentityLink(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 theIdentityLinks 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) voidhandleBpmnError(String taskId, String errorCode) Signals that a business error appears, which should be handled by the process engine.voidhandleBpmnError(String taskId, String errorCode, String errorMessage) voidvoidhandleEscalation(String taskId, String escalationCode) Signals that an escalation appears, which should be handled by the process engine.voidSignals 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 idvoidremoveVariable(String taskId, String variableName) Removes the variable from the task.voidremoveVariableLocal(String taskId, String variableName) Removes the variable from the task (not considering parent scopes).voidremoveVariables(String taskId, Collection<String> variableNames) Removes all variables in the given collection from the task.voidremoveVariablesLocal(String taskId, Collection<String> variableNames) Removes all variables in the given collection from the task (not considering parent scopes).voidresolveTask(String taskId) voidresolveTask(String taskId, Map<String, Object> variables) voidsaveAttachment(Attachment attachment) Update the name and decription of an attachmentvoidSaves the given task to the persistent data store.voidsetAssignee(String taskId, String userId) Changes the assignee of the given task to the given userId.voidsetDescription(String taskId, String description) Changes the description of the task.voidsetDueDate(String taskId, Date dueDate) Changes the dueDate of the task.voidsetFollowUpDate(String taskId, Date followUpDate) Changes the dueDate of the task.voidChanges the name of the task.voidTransfers ownership of this task to another user.voidsetPriority(String taskId, int priority) Changes the priority of the task.voidsetVariable(String taskId, String variableName, Object value) Set variable on a task.voidsetVariableLocal(String taskId, String variableName, Object value) Set variable on a task.voidsetVariables(String taskId, Map<String, ? extends Object> variables) Set variables on a task.protected voidsetVariables(String taskId, Map<String, ? extends Object> variables, boolean local) voidsetVariablesLocal(String taskId, Map<String, ? extends Object> variables) Set variables on a task.voidupdateVariables(String taskId, Map<String, ? extends Object> modifications, Collection<String> deletions) protected voidupdateVariables(String taskId, Map<String, ? extends Object> modifications, Collection<String> deletions, boolean local) voidupdateVariablesLocal(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:TaskServiceCreates 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:
newTaskin interfaceTaskService
-
newTask
Description copied from interface:TaskServicecreate a new task with a user defined task id- Specified by:
newTaskin interfaceTaskService
-
saveTask
Description copied from interface:TaskServiceSaves 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:
saveTaskin interfaceTaskService- Parameters:
task- the task, cannot be null.
-
deleteTask
Description copied from interface:TaskServiceDeletes the given task, not deleting historic information that is related to this task.- Specified by:
deleteTaskin 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:TaskServiceDeletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasksin 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:TaskServiceDeletes the given task.- Specified by:
deleteTaskin 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:TaskServiceDeletes all tasks of the given collection.- Specified by:
deleteTasksin 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:TaskServiceDeletes the given task, not deleting historic information that is related to this task.- Specified by:
deleteTaskin 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:TaskServiceDeletes all tasks of the given collection, not deleting historic information that is related to these tasks.- Specified by:
deleteTasksin 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:TaskServiceChanges 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:
setAssigneein interfaceTaskService- Parameters:
taskId- id of the task, cannot be null.userId- id of the user to use as assignee.
-
setOwner
Description copied from interface:TaskServiceTransfers ownership of this task to another user. No check is done whether the user is known by the identity component.- Specified by:
setOwnerin interfaceTaskService- Parameters:
taskId- id of the task, cannot be null.userId- of the person that is receiving ownership.
-
addCandidateUser
Description copied from interface:TaskServiceConvenience shorthand forTaskService.addUserIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATE- Specified by:
addCandidateUserin 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:TaskServiceConvenience shorthand forTaskService.addGroupIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATE- Specified by:
addCandidateGroupin 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:TaskServiceInvolves a user with a task. The type of identity link is defined by the given identityLinkType.- Specified by:
addUserIdentityLinkin 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:TaskServiceInvolves a group with a task. The type of identityLink is defined by the given identityLink.- Specified by:
addGroupIdentityLinkin 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:TaskServiceConvenience shorthand forTaskService.deleteGroupIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATE- Specified by:
deleteCandidateGroupin 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:TaskServiceConvenience shorthand forTaskService.deleteUserIdentityLink(String, String, String); with typeIdentityLinkType.CANDIDATE- Specified by:
deleteCandidateUserin 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:TaskServiceRemoves the association between a group and a task for the given identityLinkType.- Specified by:
deleteGroupIdentityLinkin 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:TaskServiceRemoves the association between a user and a task for the given identityLinkType.- Specified by:
deleteUserIdentityLinkin 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:TaskServiceRetrieves theIdentityLinks associated with the given task. Such anIdentityLinkinforms how a certain identity (eg. group or user) is associated with a certain task (eg. as candidate, assignee, etc.)- Specified by:
getIdentityLinksForTaskin interfaceTaskService
-
claim
Description copied from interface:TaskServiceClaim responsibility for a task: the given user is madeassigneefor 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:
claimin 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:TaskServiceMarks 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:
completein interfaceTaskService- Parameters:
taskId- the id of the task to complete, cannot be null.
-
complete
Description copied from interface:TaskServiceMarks 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 theassigneeand the required task parameters have been provided.- Specified by:
completein 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:TaskServiceMarks 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 theassigneeand the required task parameters have been provided.- Specified by:
completeWithVariablesInReturnin interfaceTaskService- Parameters:
taskId- the id of the task to complete, cannot be null.variables- task parameters. May be null or empty.deserializeValues- if false, returnedSerializableValues 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:TaskServiceDelegates the task to another user. This means that theassigneeis set and thedelegation stateis set toDelegationState.PENDING. If no owner is set on the task, the owner is set to the currentassigneeof the task. The new assignee must useTaskService.resolveTask(String)to report back to the owner. Only the owner cancompletethe task.- Specified by:
delegateTaskin 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:TaskServiceMarks that theassigneeis done with the taskdelegatedto her and that it can be sent back to theowner. Can only be called when this task isDelegationState.PENDINGdelegation. After this method returns, thedelegation stateis set toDelegationState.RESOLVEDand the task can becompleted.- Specified by:
resolveTaskin interfaceTaskService- Parameters:
taskId- the id of the task to resolve, cannot be null.
-
resolveTask
Description copied from interface:TaskServiceMarks that theassigneeis done with the taskdelegatedto her and that it can be sent back to theownerwith the provided variables. Can only be called when this task isDelegationState.PENDINGdelegation. After this method returns, thedelegation stateis set toDelegationState.RESOLVEDand the task can becompleted.- Specified by:
resolveTaskin interfaceTaskService
-
setPriority
Description copied from interface:TaskServiceChanges the priority of the task.Authorization: actual owner / business admin
- Specified by:
setPriorityin interfaceTaskService- Parameters:
taskId- id of the task, cannot be null.priority- the new priority for the task.
-
setName
Description copied from interface:TaskServiceChanges the name of the task.- Specified by:
setNamein interfaceTaskService- Parameters:
taskId- id of the task, not nullname- the new task name, not null
-
setDescription
Description copied from interface:TaskServiceChanges the description of the task.- Specified by:
setDescriptionin interfaceTaskService- Parameters:
taskId- id of the task, not nulldescription- the new task description, not null
-
setDueDate
Description copied from interface:TaskServiceChanges the dueDate of the task.- Specified by:
setDueDatein interfaceTaskService- Parameters:
taskId- id of the task, not nulldueDate- the new task dueDate, not null
-
setFollowUpDate
Description copied from interface:TaskServiceChanges the dueDate of the task.- Specified by:
setFollowUpDatein interfaceTaskService- Parameters:
taskId- id of the task, not nullfollowUpDate- the new task followUpDate, not null
-
createTaskQuery
Description copied from interface:TaskServiceReturns a newTaskQuerythat can be used to dynamically query tasks.- Specified by:
createTaskQueryin interfaceTaskService
-
createNativeTaskQuery
Description copied from interface:TaskServiceReturns a new- Specified by:
createNativeTaskQueryin interfaceTaskService
-
getVariables
Description copied from interface:TaskServiceGet 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:
getVariablesin interfaceTaskService
-
getVariablesTyped
Description copied from interface:TaskServiceGet 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:
getVariablesTypedin interfaceTaskService- Parameters:
taskId- the id of the task
-
getVariablesTyped
Description copied from interface:TaskServiceGet 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:
getVariablesTypedin interfaceTaskService- Parameters:
taskId- the id of the taskdeserializeValues- if false,SerializableValueswill not be deserialized.
-
getVariablesLocal
Description copied from interface:TaskServiceGet 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:
getVariablesLocalin interfaceTaskService
-
getVariablesLocalTyped
Description copied from interface:TaskServiceGet 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:
getVariablesLocalTypedin interfaceTaskService- Parameters:
taskId- the id of the task
-
getVariablesLocalTyped
Description copied from interface:TaskServiceGet 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:
getVariablesLocalTypedin interfaceTaskService- Parameters:
taskId- the id of the taskdeserializeValues- if false,SerializableValueswill not be deserialized.
-
getVariables
Description copied from interface:TaskServiceGet values for all given variableNames- Specified by:
getVariablesin interfaceTaskService
-
getVariablesTyped
public VariableMap getVariablesTyped(String taskId, Collection<String> variableNames, boolean deserializeValues) Description copied from interface:TaskServiceGet values for all given variableName- Specified by:
getVariablesTypedin interfaceTaskService- Parameters:
taskId- the id of the taskvariableNames- only fetch variables whose names are in the collection.deserializeValues- if false,SerializableValueswill not be deserialized.
-
getVariablesLocal
Description copied from interface:TaskServiceGet a variable on a task- Specified by:
getVariablesLocalin interfaceTaskService
-
getVariablesLocalTyped
public VariableMap getVariablesLocalTyped(String taskId, Collection<String> variableNames, boolean deserializeValues) Description copied from interface:TaskServiceGet values for all given variableName. Only search in the local task scope.- Specified by:
getVariablesLocalTypedin interfaceTaskService- Parameters:
taskId- the id of the taskvariableNames- only fetch variables whose names are in the collection.deserializeValues- if false,SerializableValueswill not be deserialized.
-
getVariable
Description copied from interface:TaskServiceGet a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariablein interfaceTaskService
-
getVariableLocal
Description copied from interface:TaskServiceGet a variables and only search in the task scope.- Specified by:
getVariableLocalin interfaceTaskService
-
getVariableTyped
Description copied from interface:TaskServiceGet a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariableTypedin 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:TaskServiceGet a variables and search in the task scope and if available also the execution scopes.- Specified by:
getVariableTypedin interfaceTaskService- Parameters:
taskId- the id of the taskvariableName- the name of the variable to fetchdeserializeValue- if false a,SerializableValuewill not be deserialized.- Returns:
- the TypedValue for the variable or 'null' in case no such variable exists.
-
getVariableLocalTyped
Description copied from interface:TaskServiceGet a variables and only search in the task scope.- Specified by:
getVariableLocalTypedin 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:TaskServiceGet a variables and only search in the task scope.- Specified by:
getVariableLocalTypedin interfaceTaskService- Parameters:
taskId- the id of the taskvariableName- the name of the variable to fetchdeserializeValue- if false a,SerializableValuewill 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:TaskServiceSet 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:
setVariablein interfaceTaskService
-
setVariableLocal
Description copied from interface:TaskServiceSet variable on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariableLocalin interfaceTaskService
-
setVariables
Description copied from interface:TaskServiceSet 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:
setVariablesin interfaceTaskService
-
setVariablesLocal
Description copied from interface:TaskServiceSet variables on a task. If the variable is not already existing, it will be created in the task.- Specified by:
setVariablesLocalin interfaceTaskService
-
setVariables
-
updateVariablesLocal
-
updateVariables
-
updateVariables
-
removeVariable
Description copied from interface:TaskServiceRemoves the variable from the task. When the variable does not exist, nothing happens.- Specified by:
removeVariablein interfaceTaskService
-
removeVariableLocal
Description copied from interface:TaskServiceRemoves the variable from the task (not considering parent scopes). When the variable does not exist, nothing happens.- Specified by:
removeVariableLocalin interfaceTaskService
-
removeVariables
Description copied from interface:TaskServiceRemoves all variables in the given collection from the task. Non existing variable names are simply ignored.- Specified by:
removeVariablesin interfaceTaskService
-
removeVariablesLocal
Description copied from interface:TaskServiceRemoves all variables in the given collection from the task (not considering parent scopes). Non existing variable names are simply ignored.- Specified by:
removeVariablesLocalin interfaceTaskService
-
addComment
Description copied from interface:TaskServiceAdd a comment to a task and/or process instance.- Specified by:
addCommentin interfaceTaskService
-
createComment
Description copied from interface:TaskServiceCreates a comment to a task and/or process instance and returns the comment.- Specified by:
createCommentin interfaceTaskService
-
getTaskComments
Description copied from interface:TaskServiceThe comments related to the given task.- Specified by:
getTaskCommentsin interfaceTaskService
-
getTaskComment
Description copied from interface:TaskServiceRetrieve a particular task comment- Specified by:
getTaskCommentin interfaceTaskService
-
getTaskEvents
Description copied from interface:TaskServiceThe 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:
getTaskEventsin interfaceTaskService- See Also:
-
getProcessInstanceComments
Description copied from interface:TaskServiceThe comments related to the given process instance.- Specified by:
getProcessInstanceCommentsin interfaceTaskService
-
createAttachment
public Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content) Description copied from interface:TaskServiceAdd 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:
createAttachmentin 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:TaskServiceAdd 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:
createAttachmentin 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:TaskServiceRetrieve stream content of a particular attachment- Specified by:
getAttachmentContentin interfaceTaskService
-
getTaskAttachmentContent
Description copied from interface:TaskServiceRetrieve stream content of a particular attachment to the given task id and attachment id- Specified by:
getTaskAttachmentContentin interfaceTaskService
-
deleteAttachment
Description copied from interface:TaskServiceDelete an attachment- Specified by:
deleteAttachmentin interfaceTaskService
-
deleteTaskAttachment
Description copied from interface:TaskServiceDelete an attachment to the given task id and attachment id- Specified by:
deleteTaskAttachmentin interfaceTaskService
-
getAttachment
Description copied from interface:TaskServiceRetrieve a particular attachment- Specified by:
getAttachmentin interfaceTaskService
-
getTaskAttachment
Description copied from interface:TaskServiceRetrieve a particular attachment to the given task id and attachment id- Specified by:
getTaskAttachmentin interfaceTaskService
-
getTaskAttachments
Description copied from interface:TaskServiceThe list of attachments associated to a task- Specified by:
getTaskAttachmentsin interfaceTaskService
-
getProcessInstanceAttachments
Description copied from interface:TaskServiceThe list of attachments associated to a process instance- Specified by:
getProcessInstanceAttachmentsin interfaceTaskService
-
saveAttachment
Description copied from interface:TaskServiceUpdate the name and decription of an attachment- Specified by:
saveAttachmentin interfaceTaskService
-
getSubTasks
Description copied from interface:TaskServiceThe list of subtasks for this parent task- Specified by:
getSubTasksin interfaceTaskService
-
createTaskReport
Description copied from interface:TaskServiceInstantiate a task report- Specified by:
createTaskReportin interfaceTaskService
-
handleBpmnError
Description copied from interface:TaskServiceSignals that a business error appears, which should be handled by the process engine.- Specified by:
handleBpmnErrorin interfaceTaskService- Parameters:
taskId- the id of an existing active taskerrorCode- the error code of the corresponding bmpn error
-
handleBpmnError
- Specified by:
handleBpmnErrorin 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:
handleBpmnErrorin 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:TaskServiceSignals that an escalation appears, which should be handled by the process engine.- Specified by:
handleEscalationin interfaceTaskService- Parameters:
taskId- the id of an existing active taskescalationCode- the escalation code of the corresponding escalation
-
handleEscalation
Description copied from interface:TaskServiceSignals that an escalation appears, which should be handled by the process engine.- Specified by:
handleEscalationin interfaceTaskService- Parameters:
taskId- the id of an existing active taskescalationCode- the escalation code of the corresponding escalationvariables- the variables to pass to the execution
-