public interface IActivityService
ActivityId
and ActivityTaskId
instead
of UUID
to identify IActivity
and IActivityTask
.Modifier and Type | Interface and Description |
---|---|
static interface |
IActivityService.ITaskCompletionResult |
static class |
IActivityService.Severity |
Modifier and Type | Method and Description |
---|---|
void |
cancel(UUID pTaskID,
String pCompletionComments)
Deprecated.
|
void |
claimTask(ActivityTaskId taskId)
Claim the
IActivityTask with provided ID |
void |
claimTask(UUID pTaskID)
Deprecated.
Use
claimTask(ActivityTaskId) instead |
IActivityService.ITaskCompletionResult |
completeTask(ActivityTaskId taskId,
IWorkflowTransition transition,
String completionComments,
CompletionOptions options) |
IActivityService.ITaskCompletionResult |
completeTask(ActivityTaskId taskId,
String transitionName,
String pCompletionComments,
CompletionOptions options)
Complete a Task by following a workflow transition
|
IActivityService.ITaskCompletionResult |
completeTask(UUID pTaskID,
IWorkflowTransition transition,
String pCompletionComments,
CompletionOptions options)
Deprecated.
|
IActivityTask |
completeTask(UUID pTaskID,
String pCompletionComments,
String pTransitionToTaskName,
boolean pClaimTask,
boolean pNotifyAssignee,
Locale pNotificationLocale)
Deprecated.
|
IActivityService.ITaskCompletionResult |
completeTask(UUID pTaskID,
String transitionName,
String pCompletionComments,
CompletionOptions options)
Deprecated.
|
long |
countTasks(String pApplicationName,
TaskFilterType pFilter)
Count the number of IActivityTask matching the
TaskFilterType |
IActivity |
getActivity(ActivityId activityId)
Load
IActivity with task history |
IActivity |
getActivity(UUID pActivityUUID)
Deprecated.
Use
getActivity(ActivityId) instead |
IActivityTask |
getTask(ActivityTaskId activityTaskId)
Load
IActivityTask with the given UUID. |
IActivityTask |
getTask(UUID pTaskUUID)
Deprecated.
Use
getTask(ActivityTaskId) instead |
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.
|
void |
unclaimTask(ActivityTaskId currentTaskId,
boolean notifyAssignee,
Locale notificationLocale)
Un-Claim the
IActivityTask . |
void |
unclaimTask(UUID pCurrentTask,
boolean pNotifyAssignee,
Locale pNotificationLocale)
Deprecated.
Use
unclaimTask(ActivityTaskId,boolean,Locale)
instead |
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
- TODOActivityPermissionDeniedException
- 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
@Deprecated IActivityService.ITaskCompletionResult completeTask(UUID pTaskID, String transitionName, String pCompletionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
IActivityService.ITaskCompletionResult completeTask(ActivityTaskId taskId, String transitionName, String pCompletionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
taskId
- 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 optionsActivityIllegalStateException
- when :
ActivityPermissionDeniedException
- when CompletionOptions.isClaimNextTask()
is true and
if current user does not have permission to claim the Task
targeted by the transition@Deprecated IActivityService.ITaskCompletionResult completeTask(UUID pTaskID, IWorkflowTransition transition, String pCompletionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
completeTask(ActivityTaskId,IWorkflowTransition,String,CompletionOptions)
insteadIActivityService.ITaskCompletionResult completeTask(ActivityTaskId taskId, IWorkflowTransition transition, String completionComments, CompletionOptions options) throws ActivityIllegalStateException, ActivityPermissionDeniedException
@Deprecated long submit(UUID pTaskID, String pCompletionComments) throws ActivityIllegalStateException
completeTask(ActivityTaskId, String, String, CompletionOptions)
insteadIActivity
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 commentsActivityIllegalStateException
- if the task with given ID is not the current task or is not
claimed by current user.@Deprecated void cancel(UUID pTaskID, String pCompletionComments) throws ActivityIllegalStateException
completeTask(ActivityTaskId, String, String, CompletionOptions)
insteadIActivity
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 commentsActivityIllegalStateException
- 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(ActivityTaskId, String, String, CompletionOptions)
insteadIActivityTask
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
- TODOActivityIllegalStateException
- 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 pTransitionToTask@Deprecated void claimTask(UUID pTaskID) throws ActivityIllegalStateException, ActivityPermissionDeniedException
claimTask(ActivityTaskId)
insteadIActivityTask
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 claimTask(ActivityTaskId taskId) throws ActivityIllegalStateException, ActivityPermissionDeniedException
IActivityTask
with provided ID
If one of the following condition is not matched a
ActivityIllegalStateException
will be raised:
taskId
- 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
currentTask@Deprecated void unclaimTask(UUID pCurrentTask, boolean pNotifyAssignee, Locale pNotificationLocale) throws ActivityIllegalStateException, ActivityPermissionDeniedException
unclaimTask(ActivityTaskId,boolean,Locale)
insteadIActivityTask
.
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 messagesActivityIllegalStateException
- 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
currentTaskvoid unclaimTask(ActivityTaskId currentTaskId, boolean notifyAssignee, Locale notificationLocale) throws ActivityIllegalStateException, ActivityPermissionDeniedException
IActivityTask
.
An ActivityIllegalStateException
will be raised if under any of
the following condition:
currentTaskId
- the current task.notifyAssignee
- indicates if assignee should be notified that the task is to
be processed. This is ignored if
#isNotificationSupported()
returns falsenotificationLocale
- The locale used for notification messagesActivityIllegalStateException
- 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
currentTask@Deprecated IActivity getActivity(UUID pActivityUUID)
getActivity(ActivityId)
insteadIActivity
with task historypActivityUUID
- IActivity getActivity(ActivityId activityId)
IActivity
with task historyactivityId
- @Deprecated IActivityTask getTask(UUID pTaskUUID)
getTask(ActivityTaskId)
insteadIActivityTask
with the given UUID.pTaskUUID
- IActivityTask getTask(ActivityTaskId activityTaskId)
IActivityTask
with the given UUID.activityTaskId
- 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
- Copyright © 2016. All rights reserved.