|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IActivityService
Nested Class Summary | |
---|---|
static interface |
IActivityService.ITaskCompletionResult
|
static class |
IActivityService.Severity
|
Method Summary | |
---|---|
void |
cancel(UUID pTaskID,
String pCompletionComments)
Deprecated. use completeTask(UUID, String, String, CompletionOptions)
instead |
void |
claimTask(UUID pTaskID)
Claim the IActivityTask with provided ID |
IActivityService.ITaskCompletionResult |
completeTask(UUID pTaskID,
IWorkflowTransition transition,
String pCompletionComments,
CompletionOptions options)
|
IActivityTask |
completeTask(UUID pTaskID,
String pCompletionComments,
String pTransitionToTaskName,
boolean pClaimTask,
boolean pNotifyAssignee,
Locale pNotificationLocale)
Deprecated. use completeTask(UUID, String, String, CompletionOptions)
instead |
IActivityService.ITaskCompletionResult |
completeTask(UUID pTaskID,
String transitionName,
String pCompletionComments,
CompletionOptions options)
Complete a Task by following a workflow transition |
long |
countTasks(String pApplicationName,
TaskFilterType pFilter)
Count the number of IActivityTask matching the TaskFilterType |
IActivity |
getActivity(UUID pActivityUUID)
Load IActivity with task history |
IActivityTask |
getTask(UUID pTaskUUID)
Load IActivityTask with the given UUID. |
List<IActivityTask> |
listTasks(String pApplicationName,
TaskFilterType pFilter,
PageCriteria pPageCriteria)
Get the list of IActivityTask matching the TaskFilterType |
IActivityTask |
startActivity(IHumanTask pStartTask,
String pActivityLabel,
String pStartComments,
ActivityPriority pPriority,
boolean pClaimTask,
boolean pNotifyAssignee,
Locale pNotificationLocale)
Start an activity based on a IHumanWorkflow . |
long |
submit(UUID pTaskID,
String pCompletionComments)
Deprecated. use completeTask(UUID, String, String, CompletionOptions)
instead |
void |
unclaimTask(UUID pCurrentTask,
boolean pNotifyAssignee,
Locale pNotificationLocale)
Un-Claim the IActivityTask . |
Method Detail |
---|
IActivityTask startActivity(IHumanTask pStartTask, String pActivityLabel, String pStartComments, ActivityPriority pPriority, boolean pClaimTask, boolean pNotifyAssignee, Locale pNotificationLocale) throws ActivityPermissionDeniedException
IHumanWorkflow
.
pStartTask
- the task from which to start. This task has to be a start task
see IHumanTask.isStartTask()
pActivityLabel
- the label of the activity instancepStartComments
- the start comments of the activitypPriority
- the ActivityPriority
prioritypClaimTask
- indicates whether the start task should be claimed immediately
by current user. (current user should have the permission to
do so).pNotifyAssignee
- indicates whether start task role assignee should be notified.
This is ignored if #isNotificationSupported()
returns
falsepNotificationLocale
- TODO
ActivityPermissionDeniedException
- if current user has not the permission to start the
IHumanWorkflow
or if pClaimTask is true and user does
not have the permission to claim the IHumanTask
IActivityService.ITaskCompletionResult completeTask(UUID pTaskID, String transitionName, String pCompletionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
pTaskID
- the ID of the IActivityTask
to complete.transitionName
- the name of the outgoing IWorkflowTransition
to followpCompletionComments
- The comment used for completionoptions
- Additional options on the transition (Not used if transition
is submit or cancel), or null
if no options
ActivityIllegalStateException
- when :
ActivityPermissionDeniedException
- when CompletionOptions.isClaimNextTask()
is true and
if current user does not have permission to claim the Task
targeted by the transitionIActivityService.ITaskCompletionResult completeTask(UUID pTaskID, IWorkflowTransition transition, String pCompletionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
ActivityIllegalStateException
ActivityPermissionDeniedException
long submit(UUID pTaskID, String pCompletionComments) throws ActivityIllegalStateException
completeTask(UUID, String, String, CompletionOptions)
instead
IActivity
instance by submitting from the
IActivityTask
with provided UUID.
If one of the following condition is NOT matched a
ActivityIllegalStateException
will be raised:
pTaskID
- the ID of the task to submit. This task has to be
IHumanTask.isSubmitEnabled()
pCompletionComments
- the task completion comments
ActivityIllegalStateException
- if the task with given ID is not the current task or is not
claimed by current user.void cancel(UUID pTaskID, String pCompletionComments) throws ActivityIllegalStateException
completeTask(UUID, String, String, CompletionOptions)
instead
IActivity
instance by canceling from the
IActivityTask
with provided UUID.
If one of the following condition is not matched a
ActivityIllegalStateException
will be raised:
pTaskID
- the current task ID. This task has to be
IHumanTask.isCancelEnabled()
pCompletionComments
- the task completion comments
ActivityIllegalStateException
- if the task with given ID is not the current task or is not
claimed by current user.@Deprecated IActivityTask completeTask(UUID pTaskID, String pCompletionComments, String pTransitionToTaskName, boolean pClaimTask, boolean pNotifyAssignee, Locale pNotificationLocale) throws ActivityIllegalStateException, ActivityPermissionDeniedException
completeTask(UUID, String, String, CompletionOptions)
instead
IActivityTask
with provided ID by transitioning to
the provided IHumanTask
.
If one of the following condition is not matched a
ActivityIllegalStateException
will be raised:
pTaskID
- the current task.pCompletionComments
- completion comments for current taskpTransitionToTaskName
- the name of the IWorkflowTransition
to use for
transitionpClaimTask
- claim task immediatelypNotifyAssignee
- notify new task assignee role. This is ignored if
#isNotificationSupported()
returns falsepNotificationLocale
- TODO
ActivityIllegalStateException
- if the task with given ID is not the current task or is not
claimed by current user.
ActivityPermissionDeniedException
- if pClaimTask is true and if current user does not have
permission to claim pTransitionToTaskvoid claimTask(UUID pTaskID) throws ActivityIllegalStateException, ActivityPermissionDeniedException
IActivityTask
with provided ID
If one of the following condition is not matched a
ActivityIllegalStateException
will be raised:
pTaskID
- the current task.
ActivityIllegalStateException
- if the task with given ID is not the current task or is
already claimed.
ActivityPermissionDeniedException
- if current user does not have enough permission to claim
currentTaskvoid unclaimTask(UUID pCurrentTask, boolean pNotifyAssignee, Locale pNotificationLocale) throws ActivityIllegalStateException, ActivityPermissionDeniedException
IActivityTask
.
An ActivityIllegalStateException
will be raised if under any of
the following condition:
pCurrentTask
- the current task.pNotifyAssignee
- indicates if assignee should be notified that the task is to
be processed. This is ignored if
#isNotificationSupported()
returns falsepNotificationLocale
- The locale used for notification messages
ActivityIllegalStateException
- if the task with given ID is not the current task or is not
claimed by current user.
ActivityPermissionDeniedException
- if current user does not have enough permission to claim
currentTaskIActivity getActivity(UUID pActivityUUID)
IActivity
with task history
pActivityUUID
-
IActivityTask getTask(UUID pTaskUUID)
IActivityTask
with the given UUID.
pTaskUUID
-
List<IActivityTask> listTasks(String pApplicationName, TaskFilterType pFilter, PageCriteria pPageCriteria)
IActivityTask
matching the TaskFilterType
pApplicationName
- pFilter
- pPageCriteria
- define the first records to return and the number of
IActivityTask to return. If null all IActivityTask are
returned.
long countTasks(String pApplicationName, TaskFilterType pFilter)
TaskFilterType
pApplicationName
- pFilter
- pPageCriteria
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |