public interface UserTaskService
Modifier and Type | Method and Description |
---|---|
void |
activate(Long taskId,
String userId)
Activate the task, i.e. set the task to status Ready.
|
void |
activate(String deploymentId,
Long taskId,
String userId)
Activate the task, i.e. set the task to status Ready.
|
Long |
addAttachment(Long taskId,
String userId,
String name,
Object attachment)
Add attachment to a task
|
Long |
addAttachment(String deploymentId,
Long taskId,
String userId,
String name,
Object attachment)
Add attachment to a task
|
Long |
addComment(Long taskId,
String text,
String addedBy,
Date addedOn)
Add comment to a task
|
Long |
addComment(String deploymentId,
Long taskId,
String text,
String addedBy,
Date addedOn)
Add comment to a task
|
void |
claim(Long taskId,
String userId)
Claim responsibility for a task, i.e. set the task to status Reserved
|
void |
claim(String deploymentId,
Long taskId,
String userId)
Claim responsibility for a task, i.e. set the task to status Reserved
|
void |
complete(Long taskId,
String userId,
Map<String,Object> params)
Complete a task with the given data
|
void |
complete(String deploymentId,
Long taskId,
String userId,
Map<String,Object> params)
Complete a task with the given data
|
void |
completeAutoProgress(Long taskId,
String userId,
Map<String,Object> params)
Complete a task with the given data.
|
void |
completeAutoProgress(String deploymentId,
Long taskId,
String userId,
Map<String,Object> params)
Complete a task with the given data.
|
void |
delegate(Long taskId,
String userId,
String targetUserId)
Delegate a task from userId to targetUserId
|
void |
delegate(String deploymentId,
Long taskId,
String userId,
String targetUserId)
Delegate a task from userId to targetUserId
|
void |
deleteAttachment(Long taskId,
Long attachmentId)
Delete attachment from a task
|
void |
deleteAttachment(String deploymentId,
Long taskId,
Long attachmentId)
Delete attachment from a task
|
void |
deleteComment(Long taskId,
Long commentId)
Deletes comment from a task
|
void |
deleteComment(String deploymentId,
Long taskId,
Long commentId)
Deletes comment from a task
|
void |
deleteContent(Long taskId,
Long contentId)
Deletes content given by
contentId from given task |
void |
deleteContent(String deploymentId,
Long taskId,
Long contentId)
Deletes content given by
contentId from given task |
<T> T |
execute(String deploymentId,
org.kie.api.command.Command<T> command)
Executes provided command on the underlying command executor
|
<T> T |
execute(String deploymentId,
org.kie.api.runtime.manager.Context<?> context,
org.kie.api.command.Command<T> command)
Executes provided command on the underlying command executor
|
void |
exit(Long taskId,
String userId)
Requesting application is no longer interested in the task output
|
void |
exit(String deploymentId,
Long taskId,
String userId)
Requesting application is no longer interested in the task output
|
void |
fail(Long taskId,
String userId,
Map<String,Object> faultData)
Actual owner completes the execution of the task raising a fault.
|
void |
fail(String deploymentId,
Long taskId,
String userId,
Map<String,Object> faultData)
Actual owner completes the execution of the task raising a fault.
|
void |
forward(Long taskId,
String userId,
String targetEntityId)
Forward the task to another organization entity.
|
void |
forward(String deploymentId,
Long taskId,
String userId,
String targetEntityId)
Forward the task to another organization entity.
|
org.kie.api.task.model.Attachment |
getAttachmentById(Long taskId,
Long attachmentId)
Get attachment by identifier
|
org.kie.api.task.model.Attachment |
getAttachmentById(String deploymentId,
Long taskId,
Long attachmentId)
Get attachment by identifier
|
Object |
getAttachmentContentById(Long taskId,
Long attachmentId)
Get attachment's content by identifier
|
Object |
getAttachmentContentById(String deploymentId,
Long taskId,
Long attachmentId)
Get attachment's content by identifier
|
List<org.kie.api.task.model.Attachment> |
getAttachmentsByTaskId(Long taskId)
Get attachments for a task
|
List<org.kie.api.task.model.Attachment> |
getAttachmentsByTaskId(String deploymentId,
Long taskId)
Get attachments for a task
|
org.kie.api.task.model.Comment |
getCommentById(Long taskId,
Long commentId)
Get comment by identifier
|
org.kie.api.task.model.Comment |
getCommentById(String deploymentId,
Long taskId,
Long commentId)
Get comment by identifier
|
List<org.kie.api.task.model.Comment> |
getCommentsByTaskId(Long taskId)
Get comments for a task
|
List<org.kie.api.task.model.Comment> |
getCommentsByTaskId(String deploymentId,
Long taskId)
Get comments for a task
|
org.kie.api.task.model.Task |
getTask(Long taskId)
Returns task instance
|
org.kie.api.task.model.Task |
getTask(String deploymentId,
Long taskId)
Returns task instance
|
Map<String,Object> |
getTaskInputContentByTaskId(Long taskId)
Returns task input data of a task
|
Map<String,Object> |
getTaskInputContentByTaskId(String deploymentId,
Long taskId)
Returns task input data of a task
|
Map<String,Object> |
getTaskOutputContentByTaskId(Long taskId)
Returns task output data currently stored, might be null of no data is stored
|
Map<String,Object> |
getTaskOutputContentByTaskId(String deploymentId,
Long taskId)
Returns task output data currently stored, might be null of no data is stored
|
void |
nominate(Long taskId,
String userId,
List<org.kie.api.task.model.OrganizationalEntity> potentialOwners)
Nominate a task to be handled by potentialOwners
|
void |
nominate(String deploymentId,
Long taskId,
String userId,
List<org.kie.api.task.model.OrganizationalEntity> potentialOwners)
Nominate a task to be handled by potentialOwners
|
void |
release(Long taskId,
String userId)
Release a previously claimed task
|
void |
release(String deploymentId,
Long taskId,
String userId)
Release a previously claimed task
|
void |
resume(Long taskId,
String userId)
Resume a previously suspended task
|
void |
resume(String deploymentId,
Long taskId,
String userId)
Resume a previously suspended task
|
Long |
saveContent(Long taskId,
Map<String,Object> values)
Saves gives values as content of a task, applies to task output as input cannot be altered
|
Long |
saveContent(String deploymentId,
Long taskId,
Map<String,Object> values)
Saves gives values as content of a task, applies to task output as input cannot be altered
|
void |
setDescription(Long taskId,
String description)
Sets description of the task
|
void |
setDescription(String deploymentId,
Long taskId,
String description)
Sets description of the task
|
void |
setExpirationDate(Long taskId,
Date date)
Sets expiration date of a task to given value
|
void |
setExpirationDate(String deploymentId,
Long taskId,
Date date)
Sets expiration date of a task to given value
|
void |
setName(Long taskId,
String name)
Sets name of the task
|
void |
setName(String deploymentId,
Long taskId,
String name)
Sets name of the task
|
void |
setPriority(Long taskId,
int priority)
Sets priority of a task to given value
|
void |
setPriority(String deploymentId,
Long taskId,
int priority)
Sets priority of a task to given value
|
void |
setSkipable(Long taskId,
boolean skipable)
Sets skipable property of a task to given value
|
void |
setSkipable(String deploymentId,
Long taskId,
boolean skipable)
Sets skipable property of a task to given value
|
void |
skip(Long taskId,
String userId)
Skip a claimed task
|
void |
skip(String deploymentId,
Long taskId,
String userId)
Skip a claimed task
|
void |
start(Long taskId,
String userId)
Start the execution of the task, i.e. set the task to status InProgress.
|
void |
start(String deploymentId,
Long taskId,
String userId)
Start the execution of the task, i.e. set the task to status InProgress.
|
void |
stop(Long taskId,
String userId)
Cancel/stop the processing of the task.
|
void |
stop(String deploymentId,
Long taskId,
String userId)
Cancel/stop the processing of the task.
|
void |
suspend(Long taskId,
String userId)
Suspend a claimed task.
|
void |
suspend(String deploymentId,
Long taskId,
String userId)
Suspend a claimed task.
|
void |
updateTask(Long taskId,
String userId,
UserTaskInstanceDesc userTask,
Map<String,Object> inputData,
Map<String,Object> outputData)
Updates user task properties and data inputs and outputs.
|
void |
updateTask(String deploymentId,
Long taskId,
String userId,
UserTaskInstanceDesc userTask,
Map<String,Object> inputData,
Map<String,Object> outputData)
Updates user task properties and data inputs and outputs.
|
void activate(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid activate(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid claim(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid claim(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid complete(Long taskId, String userId, Map<String,Object> params)
taskId
- userId
- params
- TaskNotFoundException
- in case task with given id was not foundvoid complete(String deploymentId, Long taskId, String userId, Map<String,Object> params)
deploymentId
- taskId
- userId
- params
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid completeAutoProgress(Long taskId, String userId, Map<String,Object> params)
taskId
- userId
- params
- TaskNotFoundException
- in case task with given id was not foundvoid completeAutoProgress(String deploymentId, Long taskId, String userId, Map<String,Object> params)
deploymentId
- taskId
- userId
- params
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid delegate(Long taskId, String userId, String targetUserId)
taskId
- userId
- targetUserId
- TaskNotFoundException
- in case task with given id was not foundvoid delegate(String deploymentId, Long taskId, String userId, String targetUserId)
deploymentId
- taskId
- userId
- targetUserId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid exit(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid exit(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid fail(Long taskId, String userId, Map<String,Object> faultData)
taskId
- userId
- faultData
- TaskNotFoundException
- in case task with given id was not foundvoid fail(String deploymentId, Long taskId, String userId, Map<String,Object> faultData)
deploymentId
- taskId
- userId
- faultData
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid forward(Long taskId, String userId, String targetEntityId)
taskId
- userId
- targetEntityId
- TaskNotFoundException
- in case task with given id was not foundvoid forward(String deploymentId, Long taskId, String userId, String targetEntityId)
deploymentId
- taskId
- userId
- targetEntityId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid release(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid release(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid resume(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid resume(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid skip(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid skip(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid start(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid start(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid stop(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid stop(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid suspend(Long taskId, String userId)
taskId
- userId
- TaskNotFoundException
- in case task with given id was not foundvoid suspend(String deploymentId, Long taskId, String userId)
deploymentId
- taskId
- userId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid nominate(Long taskId, String userId, List<org.kie.api.task.model.OrganizationalEntity> potentialOwners)
taskId
- userId
- potentialOwners
- TaskNotFoundException
- in case task with given id was not foundvoid nominate(String deploymentId, Long taskId, String userId, List<org.kie.api.task.model.OrganizationalEntity> potentialOwners)
deploymentId
- taskId
- userId
- potentialOwners
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid setPriority(Long taskId, int priority)
taskId
- priority
- TaskNotFoundException
- in case task with given id was not foundvoid setPriority(String deploymentId, Long taskId, int priority)
deploymentId
- taskId
- priority
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid setExpirationDate(Long taskId, Date date)
taskId
- date
- TaskNotFoundException
- in case task with given id was not foundvoid setExpirationDate(String deploymentId, Long taskId, Date date)
deploymentId
- taskId
- date
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid setSkipable(Long taskId, boolean skipable)
taskId
- skipable
- TaskNotFoundException
- in case task with given id was not foundvoid setSkipable(String deploymentId, Long taskId, boolean skipable)
deploymentId
- taskId
- skipable
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid setName(Long taskId, String name)
taskId
- name
- TaskNotFoundException
- in case task with given id was not foundvoid setName(String deploymentId, Long taskId, String name)
deploymentId
- taskId
- name
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid setDescription(Long taskId, String description)
taskId
- description
- TaskNotFoundException
- in case task with given id was not foundvoid setDescription(String deploymentId, Long taskId, String description)
deploymentId
- taskId
- description
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid updateTask(Long taskId, String userId, UserTaskInstanceDesc userTask, Map<String,Object> inputData, Map<String,Object> outputData)
userId
- user id who is going to perform the updateuserTask
- user task with properties to be updatedinputData
- map of input variables to be added/replaced on a taskoutputData
- map of output variables to be added/replaced on a taskTaskNotFoundException
- in case task id was not given or task was not found with given idvoid updateTask(String deploymentId, Long taskId, String userId, UserTaskInstanceDesc userTask, Map<String,Object> inputData, Map<String,Object> outputData)
deploymentId
- userId
- user id who is going to perform the updateuserTask
- user task with properties to be updatedinputData
- map of input variables to be added/replaced on a taskoutputData
- map of output variables to be added/replaced on a taskTaskNotFoundException
- in case task id was not given or task was not found with given id or is not associated with given deployment idLong saveContent(Long taskId, Map<String,Object> values)
taskId
- values
- TaskNotFoundException
- in case task with given id was not foundLong saveContent(String deploymentId, Long taskId, Map<String,Object> values)
deploymentId
- taskId
- values
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idMap<String,Object> getTaskOutputContentByTaskId(Long taskId)
taskId
- TaskNotFoundException
- in case task with given id was not foundMap<String,Object> getTaskOutputContentByTaskId(String deploymentId, Long taskId)
deploymentId
- taskId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idMap<String,Object> getTaskInputContentByTaskId(Long taskId)
taskId
- TaskNotFoundException
- in case task with given id was not foundMap<String,Object> getTaskInputContentByTaskId(String deploymentId, Long taskId)
deploymentId
- taskId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid deleteContent(Long taskId, Long contentId)
contentId
from given tasktaskId
- contentId
- TaskNotFoundException
- in case task with given id was not foundvoid deleteContent(String deploymentId, Long taskId, Long contentId)
contentId
from given taskdeploymentId
- taskId
- contentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idLong addComment(Long taskId, String text, String addedBy, Date addedOn)
taskId
- text
- addedBy
- addedOn
- TaskNotFoundException
- in case task with given id was not foundLong addComment(String deploymentId, Long taskId, String text, String addedBy, Date addedOn)
deploymentId
- taskId
- text
- addedBy
- addedOn
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid deleteComment(Long taskId, Long commentId)
taskId
- commentId
- TaskNotFoundException
- in case task with given id was not foundvoid deleteComment(String deploymentId, Long taskId, Long commentId)
deploymentId
- taskId
- commentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idList<org.kie.api.task.model.Comment> getCommentsByTaskId(Long taskId)
taskId
- TaskNotFoundException
- in case task with given id was not foundList<org.kie.api.task.model.Comment> getCommentsByTaskId(String deploymentId, Long taskId)
deploymentId
- taskId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idorg.kie.api.task.model.Comment getCommentById(Long taskId, Long commentId)
commentId
- TaskNotFoundException
- in case task with given id was not foundorg.kie.api.task.model.Comment getCommentById(String deploymentId, Long taskId, Long commentId)
deploymentId
- commentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idLong addAttachment(Long taskId, String userId, String name, Object attachment)
taskId
- userId
- attachment
- TaskNotFoundException
- in case task with given id was not foundLong addAttachment(String deploymentId, Long taskId, String userId, String name, Object attachment)
deploymentId
- taskId
- userId
- attachment
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idvoid deleteAttachment(Long taskId, Long attachmentId)
taskId
- attachmentId
- TaskNotFoundException
- in case task with given id was not foundvoid deleteAttachment(String deploymentId, Long taskId, Long attachmentId)
deploymentId
- taskId
- attachmentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idorg.kie.api.task.model.Attachment getAttachmentById(Long taskId, Long attachmentId)
attachmentId
- TaskNotFoundException
- in case task with given id was not foundorg.kie.api.task.model.Attachment getAttachmentById(String deploymentId, Long taskId, Long attachmentId)
deploymentId
- attachmentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idObject getAttachmentContentById(Long taskId, Long attachmentId)
attachmentId
- TaskNotFoundException
- in case task with given id was not foundObject getAttachmentContentById(String deploymentId, Long taskId, Long attachmentId)
deploymentId
- attachmentId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idList<org.kie.api.task.model.Attachment> getAttachmentsByTaskId(Long taskId)
taskId
- TaskNotFoundException
- in case task with given id was not foundList<org.kie.api.task.model.Attachment> getAttachmentsByTaskId(String deploymentId, Long taskId)
deploymentId
- taskId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment idorg.kie.api.task.model.Task getTask(Long taskId)
taskId
- TaskNotFoundException
- in case task with given id was not foundorg.kie.api.task.model.Task getTask(String deploymentId, Long taskId)
deploymentId
- taskId
- TaskNotFoundException
- in case task with given id was not found or is not associated with given deployment id<T> T execute(String deploymentId, org.kie.api.command.Command<T> command)
deploymentId
- identifier of the deployment that engine should be used for executioncommand
- actual command for execution<T> T execute(String deploymentId, org.kie.api.runtime.manager.Context<?> context, org.kie.api.command.Command<T> command)
deploymentId
- identifier of the deployment that engine should be used for executioncontext
- context implementation to be used for getting runtime enginecommand
- actual command for executionCopyright © 2001–2019 JBoss by Red Hat. All rights reserved.