public interface TaskService
Task
and form related operations.Modifier and Type | Method and Description |
---|---|
void |
addCandidateGroup(String taskId,
String groupId)
Convenience shorthand for
addGroupIdentityLink(String, String, String) ; with type IdentityLinkType.CANDIDATE |
void |
addCandidateUser(String taskId,
String userId)
Convenience shorthand for
addUserIdentityLink(String, String, String) ; with type IdentityLinkType.CANDIDATE |
void |
addComment(String taskId,
String processInstanceId,
String message)
Deprecated.
Use
createComment(String, String, String) instead |
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)
Marks a task as done and continues process execution.
|
void |
complete(String taskId,
Map<String,Object> variables)
Marks a task as done and continues process execution.
|
VariableMap |
completeWithVariablesInReturn(String taskId,
Map<String,Object> variables,
boolean deserializeValues)
Marks a task as done and continues process execution.
|
Attachment |
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.
|
Attachment |
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 provided
|
Comment |
createComment(String taskId,
String processInstanceId,
String message)
Creates a comment to a task and/or process instance and returns the comment.
|
NativeTaskQuery |
createNativeTaskQuery()
Returns a new
|
TaskQuery |
createTaskQuery()
Returns a new
TaskQuery that can be used to dynamically query tasks. |
TaskReport |
createTaskReport()
Instantiate a task report
|
void |
delegateTask(String taskId,
String userId)
Delegates the task to another user.
|
void |
deleteAttachment(String attachmentId)
Delete an attachment
|
void |
deleteCandidateGroup(String taskId,
String groupId)
Convenience shorthand for
deleteGroupIdentityLink(String, String, String) ; with type IdentityLinkType.CANDIDATE |
void |
deleteCandidateUser(String taskId,
String userId)
Convenience shorthand for
deleteUserIdentityLink(String, String, String) ; with type IdentityLinkType.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 id
|
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.
|
Attachment |
getAttachment(String attachmentId)
Retrieve a particular attachment
|
InputStream |
getAttachmentContent(String attachmentId)
Retrieve stream content of a particular attachment
|
List<IdentityLink> |
getIdentityLinksForTask(String taskId)
Retrieves the
IdentityLink s associated with the given task. |
List<Attachment> |
getProcessInstanceAttachments(String processInstanceId)
The list of attachments associated to a process instance
|
List<Comment> |
getProcessInstanceComments(String processInstanceId)
The comments related to the given process instance.
|
List<Task> |
getSubTasks(String parentTaskId)
The list of subtasks for this parent task
|
Attachment |
getTaskAttachment(String taskId,
String attachmentId)
Retrieve a particular attachment to the given task id and attachment id
|
InputStream |
getTaskAttachmentContent(String taskId,
String attachmentId)
Retrieve stream content of a particular attachment to the given task id and attachment id
|
List<Attachment> |
getTaskAttachments(String taskId)
The list of attachments associated to a task
|
Comment |
getTaskComment(String taskId,
String commentId)
Retrieve a particular task comment
|
List<Comment> |
getTaskComments(String taskId)
The comments related to the given task.
|
List<Event> |
getTaskEvents(String taskId)
Deprecated.
This method has been deprecated as of camunda BPM 7.1. It has been replaced with
the operation log. See
UserOperationLogEntry and UserOperationLogQuery . |
Object |
getVariable(String taskId,
String variableName)
Get a variables and search in the task scope and if available also the execution scopes.
|
Object |
getVariableLocal(String taskId,
String variableName)
Get a variables and only search in the task scope.
|
<T extends TypedValue> |
getVariableLocalTyped(String taskId,
String variableName)
Get a variables and only search in the task scope.
|
<T extends TypedValue> |
getVariableLocalTyped(String taskId,
String variableName,
boolean deserializeValue)
Get a variables and only search in the task scope.
|
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
|
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
|
VariableMap |
getVariablesLocalTyped(String taskId)
Get all variables and search only in the task scope.
|
VariableMap |
getVariablesLocalTyped(String taskId,
boolean deserializeValues)
Get all variables and search only in the task scope.
|
VariableMap |
getVariablesLocalTyped(String taskId,
Collection<String> variableNames,
boolean deserializeValues)
Get values for all given variableName.
|
VariableMap |
getVariablesTyped(String taskId)
Get all variables and search in the task scope and if available also the execution scopes.
|
VariableMap |
getVariablesTyped(String taskId,
boolean deserializeValues)
Get all variables and search in the task scope and if available also the execution scopes.
|
VariableMap |
getVariablesTyped(String taskId,
Collection<String> variableNames,
boolean deserializeValues)
Get values for all given variableName
|
<T extends TypedValue> |
getVariableTyped(String taskId,
String variableName)
Get a variables and search in the task scope and if available also the execution scopes.
|
<T extends TypedValue> |
getVariableTyped(String taskId,
String variableName,
boolean deserializeValue)
Get a variables and search in the task scope and if available also the execution scopes.
|
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 |
handleBpmnError(String taskId,
String errorCode,
String errorMessage,
Map<String,Object> variables) |
void |
handleEscalation(String taskId,
String escalationCode)
Signals that an escalation appears, which should be handled by the process engine.
|
void |
handleEscalation(String taskId,
String escalationCode,
Map<String,Object> variables)
Signals that an escalation appears, which should be handled by the process engine.
|
Task |
newTask()
Creates a new task that is not related to any process instance.
|
Task |
newTask(String taskId)
create a new task with a user defined task id
|
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)
|
void |
resolveTask(String taskId,
Map<String,Object> variables)
|
void |
saveAttachment(Attachment attachment)
Update the name and decription of an attachment
|
void |
saveTask(Task task)
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 |
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.
|
Task newTask()
saveTask(Task)
'manually'.AuthorizationException
- if the user has no Permissions.CREATE
permission on Resources.TASK
.void saveTask(Task task)
task
- the task, cannot be null.AuthorizationException
- If the task is already present and the user has no Permissions.UPDATE
permission
on Resources.TASK
or no Permissions.UPDATE_TASK
permission on
Resources.PROCESS_DEFINITION
.
Or if the task is not present and the user has no Permissions.CREATE
permission
on Resources.TASK
.void deleteTask(String taskId)
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.ProcessEngineException
- when an error occurs while deleting the task or in case the task is part
of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void deleteTasks(Collection<String> taskIds)
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.ProcessEngineException
- when an error occurs while deleting the tasks or in case one of the tasks
is part of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void deleteTask(String taskId, boolean cascade)
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.ProcessEngineException
- when an error occurs while deleting the task or in case the task is part
of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void deleteTasks(Collection<String> taskIds, boolean cascade)
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.ProcessEngineException
- when an error occurs while deleting the tasks or in case one of the tasks
is part of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void deleteTask(String taskId, String deleteReason)
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.ProcessEngineException
- when an error occurs while deleting the task or in case the task is part
of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void deleteTasks(Collection<String> taskIds, String deleteReason)
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.ProcessEngineException
- when an error occurs while deleting the tasks or in case one of the tasks
is part of a running process or case instance.AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.TASK
.void claim(String taskId, String userId)
assignee
for the task.
The difference with 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.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.ProcessEngineException
- when the task doesn't exist or when the task is already claimed by another user.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void complete(String taskId)
assignee
.taskId
- the id of the task to complete, cannot be null.ProcessEngineException
- when no task exists with the given id or when this task is DelegationState.PENDING
delegation.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void delegateTask(String taskId, String userId)
assignee
is set
and the delegation state
is set to
DelegationState.PENDING
.
If no owner is set on the task, the owner is set to the current
assignee
of the task.
The new assignee must use resolveTask(String)
to report back to the owner.
Only the owner can complete
the task.taskId
- The id of the task that will be delegated.userId
- The id of the user that will be set as assignee.ProcessEngineException
- when no task exists with the given id.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void resolveTask(String taskId)
assignee
is done with the task
delegated
to her and that it can be sent back to the owner
.
Can only be called when this task is DelegationState.PENDING
delegation.
After this method returns, the delegation state
is set to DelegationState.RESOLVED
and the task can be
completed
.taskId
- the id of the task to resolve, cannot be null.ProcessEngineException
- when no task exists with the given id.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void resolveTask(String taskId, Map<String,Object> variables)
assignee
is done with the task
delegated
to her and that it can be sent back to the owner
with the provided variables.
Can only be called when this task is DelegationState.PENDING
delegation.
After this method returns, the delegation state
is set to DelegationState.RESOLVED
and the task can be
completed
.taskId
- variables
- ProcessEngineException
- when no task exists with the given id.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void complete(String taskId, Map<String,Object> variables)
assignee
and the required task parameters have been provided.taskId
- the id of the task to complete, cannot be null.variables
- task parameters. May be null or empty.ProcessEngineException
- when no task exists with the given id.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).VariableMap completeWithVariablesInReturn(String taskId, Map<String,Object> variables, boolean deserializeValues)
assignee
and the required task parameters have been provided.taskId
- the id of the task to complete, cannot be null.variables
- task parameters. May be null or empty.deserializeValues
- if false, returned SerializableValue
s
will not be deserialized (unless they are passed into this method as a
deserialized value or if the BPMN process triggers deserialization)ProcessEngineException
- when no task exists with the given id.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void setAssignee(String taskId, String userId)
taskId
- id of the task, cannot be null.userId
- id of the user to use as assignee.ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void setOwner(String taskId, String userId)
taskId
- id of the task, cannot be null.userId
- of the person that is receiving ownership.ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).List<IdentityLink> getIdentityLinksForTask(String taskId)
IdentityLink
s 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.)ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has no Permissions.READ
permission on Resources.TASK
or no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void addCandidateUser(String taskId, String userId)
addUserIdentityLink(String, String, String)
; with type IdentityLinkType.CANDIDATE
taskId
- id of the task, cannot be null.userId
- id of the user to use as candidate, cannot be null.ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void addCandidateGroup(String taskId, String groupId)
addGroupIdentityLink(String, String, String)
; with type IdentityLinkType.CANDIDATE
taskId
- id of the task, cannot be null.groupId
- id of the group to use as candidate, cannot be null.ProcessEngineException
- when the task or group doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void addUserIdentityLink(String taskId, String userId, String identityLinkType)
taskId
- id of the task, cannot be null.userId
- id of the user involve, cannot be null.identityLinkType
- type of identityLink, cannot be null (@see IdentityLinkType
).ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void addGroupIdentityLink(String taskId, String groupId, String identityLinkType)
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 (@see IdentityLinkType
).ProcessEngineException
- when the task or group doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void deleteCandidateUser(String taskId, String userId)
deleteUserIdentityLink(String, String, String)
; with type IdentityLinkType.CANDIDATE
taskId
- id of the task, cannot be null.userId
- id of the user to use as candidate, cannot be null.ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void deleteCandidateGroup(String taskId, String groupId)
deleteGroupIdentityLink(String, String, String)
; with type IdentityLinkType.CANDIDATE
taskId
- id of the task, cannot be null.groupId
- id of the group to use as candidate, cannot be null.ProcessEngineException
- when the task or group doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void deleteUserIdentityLink(String taskId, String userId, String identityLinkType)
taskId
- id of the task, cannot be null.userId
- id of the user involve, cannot be null.identityLinkType
- type of identityLink, cannot be null (@see IdentityLinkType
).ProcessEngineException
- when the task or user doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void deleteGroupIdentityLink(String taskId, String groupId, String identityLinkType)
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 (@see IdentityLinkType
).ProcessEngineException
- when the task or group doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).void setPriority(String taskId, int priority)
taskId
- id of the task, cannot be null.priority
- the new priority for the task.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has no Permissions.UPDATE
permission on Resources.TASK
or no Permissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
(if the task is part of a running process instance).TaskQuery createTaskQuery()
TaskQuery
that can be used to dynamically query tasks.NativeTaskQuery createNativeTaskQuery()
void setVariable(String taskId, String variableName, Object value)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void setVariables(String taskId, Map<String,? extends Object> variables)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void setVariableLocal(String taskId, String variableName, Object value)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void setVariablesLocal(String taskId, Map<String,? extends Object> variables)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
Object getVariable(String taskId, String variableName)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
<T extends TypedValue> T getVariableTyped(String taskId, String variableName)
taskId
- the id of the taskvariableName
- the name of the variable to fetchClassCastException
- in case the value is not of the requested typeProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
<T extends TypedValue> T getVariableTyped(String taskId, String variableName, boolean deserializeValue)
taskId
- the id of the taskvariableName
- the name of the variable to fetchdeserializeValue
- if false a, SerializableValue
will not be deserialized.ClassCastException
- in case the value is not of the requested typeProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
Object getVariableLocal(String taskId, String variableName)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
<T extends TypedValue> T getVariableLocalTyped(String taskId, String variableName)
taskId
- the id of the taskvariableName
- the name of the variable to fetchClassCastException
- in case the value is not of the requested typeProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
<T extends TypedValue> T getVariableLocalTyped(String taskId, String variableName, boolean deserializeValue)
taskId
- the id of the taskvariableName
- the name of the variable to fetchdeserializeValue
- if false a, SerializableValue
will not be deserialized.ClassCastException
- in case the value is not of the requested typeProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
Map<String,Object> getVariables(String taskId)
getVariables(String, Collection)
for better performance.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesTyped(String taskId)
getVariables(String, Collection)
for better performance.taskId
- the id of the taskProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesTyped(String taskId, boolean deserializeValues)
getVariables(String, Collection)
for better performance.taskId
- the id of the taskdeserializeValues
- if false, SerializableValues
will not be deserialized.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
Map<String,Object> getVariablesLocal(String taskId)
getVariablesLocal(String, Collection)
for better performance.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesLocalTyped(String taskId)
getVariablesLocal(String, Collection)
for better performance.taskId
- the id of the taskdeserializeValues
- if false, SerializableValues
will not be deserialized.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesLocalTyped(String taskId, boolean deserializeValues)
getVariablesLocal(String, Collection)
for better performance.taskId
- the id of the taskdeserializeValues
- if false, SerializableValues
will not be deserialized.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
Map<String,Object> getVariables(String taskId, Collection<String> variableNames)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesTyped(String taskId, Collection<String> variableNames, boolean deserializeValues)
taskId
- the id of the taskvariableNames
- only fetch variables whose names are in the collection.deserializeValues
- if false, SerializableValues
will not be deserialized.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
Map<String,Object> getVariablesLocal(String taskId, Collection<String> variableNames)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
VariableMap getVariablesLocalTyped(String taskId, Collection<String> variableNames, boolean deserializeValues)
taskId
- the id of the taskvariableNames
- only fetch variables whose names are in the collection.deserializeValues
- if false, SerializableValues
will not be deserialized.ProcessEngineException
- when the task doesn't exist.AuthorizationException
- In case of standalone tasks:
Permissions.READ
permission on Resources.TASK
orthis
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
In case the task is part of a running process instance:
Permissions.READ
permission on Resources.TASK
and
no Permissions.READ_TASK
permission on Resources.PROCESS_DEFINITION
this
configuration is enabled and
the user has no TaskPermissions.READ_VARIABLE
permission on Resources.TASK
and
no ProcessDefinitionPermissions.READ_TASK_VARIABLE
permission on Resources.PROCESS_DEFINITION
void removeVariable(String taskId, String variableName)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void removeVariableLocal(String taskId, String variableName)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void removeVariables(String taskId, Collection<String> variableNames)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
void removeVariablesLocal(String taskId, Collection<String> variableNames)
ProcessEngineException
- when the task doesn't exist.AuthorizationException
- If the user has none of the following:
TaskPermissions.UPDATE_VARIABLE
permission on Resources.TASK
Permissions.UPDATE
permission on Resources.TASK
@Deprecated void addComment(String taskId, String processInstanceId, String message)
createComment(String, String, String)
insteadComment createComment(String taskId, String processInstanceId, String message)
List<Comment> getTaskComments(String taskId)
Comment getTaskComment(String taskId, String commentId)
@Deprecated List<Event> getTaskEvents(String taskId)
UserOperationLogEntry
and UserOperationLogQuery
.The all events related to the given task.
As of Camunda BPM 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 to true
.
List<Comment> getProcessInstanceComments(String processInstanceId)
Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content)
taskId
- - task that should have an attachmentprocessInstanceId
- - id of a process to use if task id is nullattachmentType
- - name of the attachment, can be nullattachmentName
- - name of the attachment, can be nullattachmentDescription
- - full text description, can be nullcontent
- - byte array with content of attachmentAttachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, String url)
taskId
- - task that should have an attachmentprocessInstanceId
- - id of a process to use if task id is nullattachmentType
- - name of the attachment, can be nullattachmentName
- - name of the attachment, can be nullattachmentDescription
- - full text description, can be nullurl
- - url of the attachment, can be nullvoid saveAttachment(Attachment attachment)
Attachment getAttachment(String attachmentId)
Attachment getTaskAttachment(String taskId, String attachmentId)
InputStream getAttachmentContent(String attachmentId)
InputStream getTaskAttachmentContent(String taskId, String attachmentId)
List<Attachment> getTaskAttachments(String taskId)
List<Attachment> getProcessInstanceAttachments(String processInstanceId)
void deleteAttachment(String attachmentId)
void deleteTaskAttachment(String taskId, String attachmentId)
TaskReport createTaskReport()
void handleBpmnError(String taskId, String errorCode)
taskId
- the id of an existing active taskerrorCode
- the error code of the corresponding bmpn errorNullValueException
- if no task with the given id existsSuspendedEntityInteractionException
- if the task is suspendedAuthorizationException
- if the user has none of the following permissions:
Permissions.TASK_WORK
permission on Resources.TASK
or
Resources.PROCESS_DEFINITION
resourcePermissions.UPDATE
permission on Resources.TASK
resourcePermissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
resourcevoid handleBpmnError(String taskId, String errorCode, String errorMessage)
taskId
- the id of an existing active taskerrorCode
- the error code of the corresponding bmpn errorerrorMessage
- the error message of the corresponding bmpn errorhandleBpmnError(String, String)
void handleBpmnError(String taskId, String errorCode, String errorMessage, Map<String,Object> variables)
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 executionhandleBpmnError(String, String)
void handleEscalation(String taskId, String escalationCode)
taskId
- the id of an existing active taskescalationCode
- the escalation code of the corresponding escalationvariables
- the variables to pass to the executionNullValueException
- if no task with the given id existsSuspendedEntityInteractionException
- if the task is suspendedAuthorizationException
- if the user has none of the following permissions:
Permissions.TASK_WORK
permission on Resources.TASK
or
Resources.PROCESS_DEFINITION
resourcePermissions.UPDATE
permission on Resources.TASK
resourcePermissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
resourcevoid handleEscalation(String taskId, String escalationCode, Map<String,Object> variables)
taskId
- the id of an existing active taskescalationCode
- the escalation code of the corresponding escalationvariables
- the variables to pass to the executionNullValueException
- if no task with the given id existsSuspendedEntityInteractionException
- if the task is suspendedAuthorizationException
- if the user has none of the following permissions:
Permissions.TASK_WORK
permission on Resources.TASK
or
Resources.PROCESS_DEFINITION
resourcePermissions.UPDATE
permission on Resources.TASK
resourcePermissions.UPDATE_TASK
permission on Resources.PROCESS_DEFINITION
resourceCopyright © 2019. All rights reserved.