public class TaskServiceImpl extends ServiceImpl implements TaskService
commandExecutor, processEngineConfiguration| Constructor and Description |
|---|
TaskServiceImpl() |
TaskServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration) |
| Modifier and Type | Method and Description |
|---|---|
void |
addCandidateGroup(String taskId,
String groupId)
Convenience shorthand for
TaskService.addGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE |
void |
addCandidateUser(String taskId,
String userId)
Convenience shorthand for
TaskService.addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE |
Comment |
addComment(String taskId,
String processInstance,
String message)
Add a comment to a task and/or process instance.
|
Comment |
addComment(String taskId,
String processInstance,
String type,
String message)
Add a comment to a task and/or process instance with a custom type.
|
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)
Called when the task is successfully executed.
|
void |
complete(String taskId,
Map<String,Object> variables)
Called when the task is successfully executed,
and the required task parameters are given by the end-user.
|
void |
complete(String taskId,
Map<String,Object> variables,
boolean localScope)
Called when the task is successfully executed,
and the required task paramaters are given by the end-user.
|
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
|
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
|
NativeTaskQuery |
createNativeTaskQuery()
Returns a new
NativeQuery for tasks. |
TaskQuery |
createTaskQuery()
Returns a new
TaskQuery that can be used to dynamically query tasks. |
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
TaskService.deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE |
void |
deleteCandidateUser(String taskId,
String userId)
Convenience shorthand for
TaskService.deleteUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATE |
void |
deleteComment(String commentId)
Removes an individual comment with the given id.
|
void |
deleteComments(String taskId,
String processInstanceId)
Removes all comments from the provided task and/or process instance
|
void |
deleteGroupIdentityLink(String taskId,
String groupId,
String identityLinkType)
Removes the association between a group and a task for the given identityLinkType.
|
void |
deleteTask(String taskId)
Deletes the given task, not deleting historic information that is related to this task.
|
void |
deleteTask(String taskId,
boolean cascade)
Deletes the given task.
|
void |
deleteTask(String taskId,
String deleteReason)
Deletes the given task, not deleting historic information that is related to this task..
|
void |
deleteTasks(Collection<String> taskIds)
Deletes all tasks of the given collection, not deleting historic information that is related
to these tasks.
|
void |
deleteTasks(Collection<String> taskIds,
boolean cascade)
Deletes all tasks of the given collection.
|
void |
deleteTasks(Collection<String> taskIds,
String deleteReason)
Deletes all tasks of the given collection, not deleting historic information that is related to these tasks.
|
void |
deleteUserIdentityLink(String taskId,
String userId,
String identityLinkType)
Removes the association between a user and a task for the given identityLinkType.
|
Attachment |
getAttachment(String attachmentId)
Retrieve a particular attachment
|
InputStream |
getAttachmentContent(String attachmentId)
Retrieve stream content of a particular attachment
|
Comment |
getComment(String commentId)
Returns an individual comment with the given id.
|
List<Comment> |
getCommentsByType(String type)
All comments of a given type.
|
Event |
getEvent(String eventId)
Returns an individual event with the given id.
|
List<IdentityLink> |
getIdentityLinksForTask(String taskId)
Retrieves the
IdentityLinks 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<Comment> |
getProcessInstanceComments(String processInstanceId,
String type)
The comments related to the given process instance.
|
List<Task> |
getSubTasks(String parentTaskId)
The list of subtasks for this parent task
|
List<Attachment> |
getTaskAttachments(String taskId)
The list of attachments associated to a task
|
List<Comment> |
getTaskComments(String taskId)
The comments related to the given task.
|
List<Comment> |
getTaskComments(String taskId,
String type)
The comments related to the given task of the given type.
|
List<Event> |
getTaskEvents(String taskId)
The all events related to the given task.
|
Object |
getVariable(String executionId,
String variableName)
get a variables and search in the task scope and if available also the execution scopes.
|
<T> T |
getVariable(String taskId,
String variableName,
Class<T> variableClass)
get a variables and search in the task scope and if available also the execution scopes.
|
Object |
getVariableLocal(String executionId,
String variableName)
checks whether or not the task has a variable defined with the given name.
|
<T> T |
getVariableLocal(String taskId,
String variableName,
Class<T> variableClass)
checks whether or not the task has a variable defined with the given name.
|
Map<String,Object> |
getVariables(String executionId)
get all variables and search in the task scope and if available also the execution scopes.
|
Map<String,Object> |
getVariables(String executionId,
Collection<String> variableNames)
get values for all given variableNames and search only in the task scope.
|
Map<String,Object> |
getVariablesLocal(String executionId)
get all variables and search only in the task scope.
|
Map<String,Object> |
getVariablesLocal(String executionId,
Collection<String> variableNames)
get a variable on a task
|
boolean |
hasVariable(String taskId,
String variableName)
checks whether or not the task has a variable defined with the given name, in the task scope and if available also the execution scopes.
|
boolean |
hasVariableLocal(String taskId,
String variableName)
checks whether or not the task has a variable defined with the given name, local task scope only.
|
Task |
newTask()
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)
Marks that the assignee is done with this task and that it can be send back to the owner.
|
void |
resolveTask(String taskId,
Map<String,Object> variables)
Marks that the assignee is done with this task providing the required
variables and that it can be sent back to the owner.
|
void |
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 |
setDueDate(String taskId,
Date dueDate)
Changes the due date of the task
|
void |
setOwner(String taskId,
String userId)
Transfers ownership of this task to another user.
|
void |
setPriority(String taskId,
int priority)
Changes the priority of the task.
|
void |
setVariable(String executionId,
String variableName,
Object value)
set variable on a task.
|
void |
setVariableLocal(String executionId,
String variableName,
Object value)
set variable on a task.
|
void |
setVariables(String executionId,
Map<String,? extends Object> variables)
set variables on a task.
|
void |
setVariablesLocal(String executionId,
Map<String,? extends Object> variables)
set variables on a task.
|
void |
unclaim(String taskId)
A shortcut to
TaskService.claim(java.lang.String, java.lang.String) with null user in order to unclaim the task |
getCommandExecutor, setCommandExecutorpublic TaskServiceImpl()
public TaskServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration)
public Task newTask()
TaskServiceTaskService.saveTask(Task) 'manually'.newTask in interface TaskServicepublic Task newTask(String taskId)
TaskServicenewTask in interface TaskServicepublic void saveTask(Task task)
TaskServicesaveTask in interface TaskServicetask - the task, cannot be null.public void deleteTask(String taskId)
TaskServicedeleteTask in interface TaskServicetaskId - The id of the task that will be deleted, cannot be null. If no task
exists with the given taskId, the operation is ignored.public void deleteTasks(Collection<String> taskIds)
TaskServicedeleteTasks in interface TaskServicetaskIds - The id's of the tasks that will be deleted, cannot be null. All
id's in the list that don't have an existing task will be ignored.public void deleteTask(String taskId, boolean cascade)
TaskServicedeleteTask in interface TaskServicetaskId - The id of the task that will be deleted, cannot be null. If no task
exists with the given taskId, the operation is ignored.cascade - If cascade is true, also the historic information related to this task is deleted.public void deleteTasks(Collection<String> taskIds, boolean cascade)
TaskServicedeleteTasks in interface TaskServicetaskIds - The id's of the tasks that will be deleted, cannot be null. All
id's in the list that don't have an existing task will be ignored.cascade - If cascade is true, also the historic information related to this task is deleted.public void deleteTask(String taskId, String deleteReason)
TaskServicedeleteTask in interface TaskServicetaskId - The id of the task that will be deleted, cannot be null. If no task
exists with the given taskId, the operation is ignored.deleteReason - reason the task is deleted. Is recorded in history, if enabled.public void deleteTasks(Collection<String> taskIds, String deleteReason)
TaskServicedeleteTasks in interface TaskServicetaskIds - The id's of the tasks that will be deleted, cannot be null. All
id's in the list that don't have an existing task will be ignored.deleteReason - reason the task is deleted. Is recorded in history, if enabled.public void setAssignee(String taskId, String userId)
TaskServicesetAssignee in interface TaskServicetaskId - id of the task, cannot be null.userId - id of the user to use as assignee.public void setOwner(String taskId, String userId)
TaskServicesetOwner in interface TaskServicetaskId - id of the task, cannot be null.userId - of the person that is receiving ownership.public void addCandidateUser(String taskId, String userId)
TaskServiceTaskService.addUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATEaddCandidateUser in interface TaskServicetaskId - id of the task, cannot be null.userId - id of the user to use as candidate, cannot be null.public void addCandidateGroup(String taskId, String groupId)
TaskServiceTaskService.addGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATEaddCandidateGroup in interface TaskServicetaskId - id of the task, cannot be null.groupId - id of the group to use as candidate, cannot be null.public void addUserIdentityLink(String taskId, String userId, String identityLinkType)
TaskServiceaddUserIdentityLink in interface TaskServicetaskId - 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).public void addGroupIdentityLink(String taskId, String groupId, String identityLinkType)
TaskServiceaddGroupIdentityLink in interface TaskServicetaskId - 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).public void deleteCandidateGroup(String taskId, String groupId)
TaskServiceTaskService.deleteGroupIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATEdeleteCandidateGroup in interface TaskServicetaskId - id of the task, cannot be null.groupId - id of the group to use as candidate, cannot be null.public void deleteCandidateUser(String taskId, String userId)
TaskServiceTaskService.deleteUserIdentityLink(String, String, String); with type IdentityLinkType.CANDIDATEdeleteCandidateUser in interface TaskServicetaskId - id of the task, cannot be null.userId - id of the user to use as candidate, cannot be null.public void deleteGroupIdentityLink(String taskId, String groupId, String identityLinkType)
TaskServicedeleteGroupIdentityLink in interface TaskServicetaskId - 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).public void deleteUserIdentityLink(String taskId, String userId, String identityLinkType)
TaskServicedeleteUserIdentityLink in interface TaskServicetaskId - 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).public List<IdentityLink> getIdentityLinksForTask(String taskId)
TaskServiceIdentityLinks associated with the given task.
Such an IdentityLink informs how a certain identity (eg. group or user)
is associated with a certain task (eg. as candidate, assignee, etc.)getIdentityLinksForTask in interface TaskServicepublic void claim(String taskId, String userId)
TaskServiceTaskService.setAssignee(String, String) is that here
a check is done if the task already has a user assigned to it.
No check is done whether the user is known by the identity component.claim in interface TaskServicetaskId - task to claim, cannot be null.userId - user that claims the task. When userId is null the task is unclaimed,
assigned to no one.public void unclaim(String taskId)
TaskServiceTaskService.claim(java.lang.String, java.lang.String) with null user in order to unclaim the taskunclaim in interface TaskServicetaskId - task to unclaim, cannot be null.public void complete(String taskId)
TaskServicecomplete in interface TaskServicetaskId - the id of the task to complete, cannot be null.public void complete(String taskId, Map<String,Object> variables)
TaskServicecomplete in interface TaskServicetaskId - the id of the task to complete, cannot be null.variables - task parameters. May be null or empty.public void complete(String taskId, Map<String,Object> variables, boolean localScope)
TaskServicecomplete in interface TaskServicetaskId - the id of the task to complete, cannot be null.variables - task parameters. May be null or empty.localScope - If true, the provided variables will be stored task-local,
instead of process instance wide (which is the default for TaskService.complete(String, Map)).public void delegateTask(String taskId, String userId)
TaskServiceDelegationState#PENDING.
If no owner is set on the task, the owner is set to the current assignee
of the task.delegateTask in interface TaskServicetaskId - The id of the task that will be delegated.userId - The id of the user that will be set as assignee.public void resolveTask(String taskId)
TaskServiceDelegationState#PENDING delegation.
After this method returns, the delegationState is set to DelegationState#RESOLVED.resolveTask in interface TaskServicetaskId - the id of the task to resolve, cannot be null.public void resolveTask(String taskId, Map<String,Object> variables)
TaskServiceDelegationState#PENDING delegation. After this
method returns, the delegationState is
set to DelegationState#RESOLVED.resolveTask in interface TaskServicepublic void setPriority(String taskId, int priority)
TaskServicesetPriority in interface TaskServicetaskId - id of the task, cannot be null.priority - the new priority for the task.public void setDueDate(String taskId, Date dueDate)
TaskServicesetDueDate in interface TaskServicetaskId - id of the task, cannot be null.dueDate - the new due date for the taskpublic TaskQuery createTaskQuery()
TaskServiceTaskQuery that can be used to dynamically query tasks.createTaskQuery in interface TaskServicepublic NativeTaskQuery createNativeTaskQuery()
TaskServiceNativeQuery for tasks.createNativeTaskQuery in interface TaskServicepublic Map<String,Object> getVariables(String executionId)
TaskServiceTaskService.getVariables(String, Collection)
for better performance.getVariables in interface TaskServicepublic Map<String,Object> getVariablesLocal(String executionId)
TaskServiceTaskService.getVariablesLocal(String, Collection)
for better performance.getVariablesLocal in interface TaskServicepublic Map<String,Object> getVariables(String executionId, Collection<String> variableNames)
TaskServicegetVariables in interface TaskServicepublic Map<String,Object> getVariablesLocal(String executionId, Collection<String> variableNames)
TaskServicegetVariablesLocal in interface TaskServicepublic Object getVariable(String executionId, String variableName)
TaskServicegetVariable in interface TaskServicepublic <T> T getVariable(String taskId, String variableName, Class<T> variableClass)
TaskServicegetVariable in interface TaskServicepublic boolean hasVariable(String taskId, String variableName)
TaskServicehasVariable in interface TaskServicepublic Object getVariableLocal(String executionId, String variableName)
TaskServicegetVariableLocal in interface TaskServicepublic <T> T getVariableLocal(String taskId, String variableName, Class<T> variableClass)
TaskServicegetVariableLocal in interface TaskServicepublic boolean hasVariableLocal(String taskId, String variableName)
TaskServicehasVariableLocal in interface TaskServicepublic void setVariable(String executionId, String variableName, Object value)
TaskServicesetVariable in interface TaskServicepublic void setVariableLocal(String executionId, String variableName, Object value)
TaskServicesetVariableLocal in interface TaskServicepublic void setVariables(String executionId, Map<String,? extends Object> variables)
TaskServicesetVariables in interface TaskServicepublic void setVariablesLocal(String executionId, Map<String,? extends Object> variables)
TaskServicesetVariablesLocal in interface TaskServicepublic void removeVariable(String taskId, String variableName)
TaskServiceremoveVariable in interface TaskServicepublic void removeVariableLocal(String taskId, String variableName)
TaskServiceremoveVariableLocal in interface TaskServicepublic void removeVariables(String taskId, Collection<String> variableNames)
TaskServiceremoveVariables in interface TaskServicepublic void removeVariablesLocal(String taskId, Collection<String> variableNames)
TaskServiceremoveVariablesLocal in interface TaskServicepublic Comment addComment(String taskId, String processInstance, String message)
TaskServiceaddComment in interface TaskServicepublic Comment addComment(String taskId, String processInstance, String type, String message)
TaskServiceaddComment in interface TaskServicepublic Comment getComment(String commentId)
TaskServicegetComment in interface TaskServicepublic Event getEvent(String eventId)
TaskServicegetEvent in interface TaskServicepublic List<Comment> getTaskComments(String taskId)
TaskServicegetTaskComments in interface TaskServicepublic List<Comment> getTaskComments(String taskId, String type)
TaskServicegetTaskComments in interface TaskServicepublic List<Comment> getCommentsByType(String type)
TaskServicegetCommentsByType in interface TaskServicepublic List<Event> getTaskEvents(String taskId)
TaskServicegetTaskEvents in interface TaskServicepublic List<Comment> getProcessInstanceComments(String processInstanceId)
TaskServicegetProcessInstanceComments in interface TaskServicepublic List<Comment> getProcessInstanceComments(String processInstanceId, String type)
TaskServicegetProcessInstanceComments in interface TaskServicepublic Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, InputStream content)
TaskServicecreateAttachment in interface TaskServicepublic Attachment createAttachment(String attachmentType, String taskId, String processInstanceId, String attachmentName, String attachmentDescription, String url)
TaskServicecreateAttachment in interface TaskServicepublic InputStream getAttachmentContent(String attachmentId)
TaskServicegetAttachmentContent in interface TaskServicepublic void deleteAttachment(String attachmentId)
TaskServicedeleteAttachment in interface TaskServicepublic void deleteComments(String taskId, String processInstanceId)
TaskServicedeleteComments in interface TaskServicepublic void deleteComment(String commentId)
TaskServicedeleteComment in interface TaskServicepublic Attachment getAttachment(String attachmentId)
TaskServicegetAttachment in interface TaskServicepublic List<Attachment> getTaskAttachments(String taskId)
TaskServicegetTaskAttachments in interface TaskServicepublic List<Attachment> getProcessInstanceAttachments(String processInstanceId)
TaskServicegetProcessInstanceAttachments in interface TaskServicepublic void saveAttachment(Attachment attachment)
TaskServicesaveAttachment in interface TaskServicepublic List<Task> getSubTasks(String parentTaskId)
TaskServicegetSubTasks in interface TaskServiceCopyright © 2016 Alfresco. All rights reserved.