|
jBPM :: Distribution 6.2.0-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserTaskService
Method Summary | ||
---|---|---|
void |
activate(Long taskId,
String userId)
Activate the task, i.e. set the task to status Ready. |
|
Long |
addAttachment(Long taskId,
String userId,
Object attachment)
Add attachment to a task |
|
Long |
addComment(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 |
complete(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 |
deleteAttachment(Long taskId,
Long attachmentId)
Delete attachment from a task |
|
void |
deleteComment(Long taskId,
Long commentId)
Deletes comment from a task |
|
void |
deleteContent(Long taskId,
Long contentId)
Deletes content given by contentId from given task |
|
|
execute(String deploymentId,
Command<T> command)
Executes provided command on the underlying command executor |
|
|
execute(String deploymentId,
Context<?> context,
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 |
fail(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. |
|
Attachment |
getAttachmentById(Long taskId,
Long attachmentId)
Get attachment by identifier |
|
Object |
getAttachmentContentById(Long taskId,
Long attachmentId)
Get attachment's content by identifier |
|
List<Attachment> |
getAttachmentsByTaskId(Long taskId)
Get attachments for a task |
|
Comment |
getCommentById(Long taskId,
Long commentId)
Get comment by identifier |
|
List<Comment> |
getCommentsByTaskId(Long taskId)
Get comments for a task |
|
Task |
getTask(Long taskId)
Returns task instance |
|
Map<String,Object> |
getTaskInputContentByTaskId(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 |
|
void |
nominate(Long taskId,
String userId,
List<OrganizationalEntity> potentialOwners)
Nominate a task to be handled by potentialOwners |
|
void |
release(Long taskId,
String userId)
Release a previously claimed task |
|
void |
resume(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 |
|
void |
setDescription(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 |
setName(Long taskId,
String name)
Sets name of the task |
|
void |
setPriority(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 |
skip(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 |
stop(Long taskId,
String userId)
Cancel/stop the processing of the task. |
|
void |
suspend(Long taskId,
String userId)
Suspend a claimed task. |
Method Detail |
---|
void activate(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid claim(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid complete(Long taskId, String userId, Map<String,Object> params)
taskId
- userId
- data
-
TaskNotFoundException
- in case task with given id was not foundvoid delegate(Long taskId, String userId, String targetUserId)
taskId
- userId
- targetUserId
-
TaskNotFoundException
- in case task with given id was not foundvoid exit(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid fail(Long taskId, String userId, Map<String,Object> faultData)
taskId
- userId
- faultData
-
TaskNotFoundException
- in case task with given id was not foundvoid forward(Long taskId, String userId, String targetEntityId)
taskId
- userId
- targetEntityId
-
TaskNotFoundException
- in case task with given id was not foundvoid release(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid resume(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid skip(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid start(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid stop(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid suspend(Long taskId, String userId)
taskId
- userId
-
TaskNotFoundException
- in case task with given id was not foundvoid nominate(Long taskId, String userId, List<OrganizationalEntity> potentialOwners)
taskId
- userId
- potentialOwners
-
TaskNotFoundException
- in case task with given id was not foundvoid setPriority(Long taskId, int priority)
taskId
- priority
-
TaskNotFoundException
- in case task with given id was not foundvoid setExpirationDate(Long taskId, Date date)
taskId
- date
-
TaskNotFoundException
- in case task with given id was not foundvoid setSkipable(Long taskId, boolean skipable)
taskId
- skipable
-
TaskNotFoundException
- in case task with given id was not foundvoid setName(Long taskId, String name)
taskId
- name
-
TaskNotFoundException
- in case task with given id was not foundvoid setDescription(Long taskId, String description)
taskId
- description
-
TaskNotFoundException
- in case task with given id was not foundLong saveContent(Long taskId, Map<String,Object> values)
taskId
- values
-
TaskNotFoundException
- in case task with given id was not foundMap<String,Object> getTaskOutputContentByTaskId(Long taskId)
taskId
-
TaskNotFoundException
- in case task with given id was not foundMap<String,Object> getTaskInputContentByTaskId(Long taskId)
taskId
-
TaskNotFoundException
- in case task with given id was not foundvoid deleteContent(Long taskId, Long contentId)
contentId
from given task
taskId
- contentId
-
TaskNotFoundException
- in case task with given id was not foundLong addComment(Long taskId, String text, String addedBy, Date addedOn)
taskId
- text
- addedBy
- addedOn
-
TaskNotFoundException
- in case task with given id was not foundvoid deleteComment(Long taskId, Long commentId)
taskId
- commentId
-
TaskNotFoundException
- in case task with given id was not foundList<Comment> getCommentsByTaskId(Long taskId)
taskId
-
TaskNotFoundException
- in case task with given id was not foundComment getCommentById(Long taskId, Long commentId)
commentId
-
TaskNotFoundException
- in case task with given id was not foundLong addAttachment(Long taskId, String userId, Object attachment)
taskId
- userId
- attachment
-
TaskNotFoundException
- in case task with given id was not foundvoid deleteAttachment(Long taskId, Long attachmentId)
taskId
- attachmentId
-
TaskNotFoundException
- in case task with given id was not foundAttachment getAttachmentById(Long taskId, Long attachmentId)
attachmentId
-
TaskNotFoundException
- in case task with given id was not foundObject getAttachmentContentById(Long taskId, Long attachmentId)
attachmentId
-
TaskNotFoundException
- in case task with given id was not foundList<Attachment> getAttachmentsByTaskId(Long taskId)
taskId
-
TaskNotFoundException
- in case task with given id was not foundTask getTask(Long taskId)
taskId
-
TaskNotFoundException
- in case task with given id was not found<T> T execute(String deploymentId, Command<T> command)
deploymentId
- identifier of the deployment that engine should be used for executioncommand
- actual command for execution
<T> T execute(String deploymentId, Context<?> context, 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 execution
|
jBPM :: Distribution 6.2.0-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |