public class InboxActionsImpl extends java.lang.Object implements InboxActions
InboxActions
. The default algorithms used
for ascertaining the next task to add to the user's My Tasks
list are defined for each of the supported hook points.Constructor and Description |
---|
InboxActionsImpl() |
Modifier and Type | Method and Description |
---|---|
long |
getNextTask(java.lang.String userName)
Searches for tasks available to the current user and the first available
task returned by the search is the next task that will be added to the
user's
My Tasks list. |
long |
getNextTaskFromPreferredOrgUnit(java.lang.String userName)
Searches for tasks available in the user's preferred organization unit
and the first available task returned by the search is the next task that
will be added to the user's
My Tasks list. |
long |
getNextTaskFromPreferredWorkQueue(java.lang.String userName)
Searches for tasks available in the user's preferred work queue and the
first available task returned by the search is the next task that will be
added to the user's
My Tasks list. |
long |
getNextTaskFromWorkQueue(java.lang.String userName,
long workQueueID)
Searches for tasks available to the specified work queue and the first
available task returned by the search is the next task that will be
added to the users
My Tasks list. |
void |
subscribeUserToWorkQueue(java.lang.String userName,
long workQueueID)
Subscribes the specified user to the specified work queue.
|
void |
unsubscribeUserFromWorkQueue(java.lang.String userName,
long workQueueID)
Un-subscribes the specified user from the specified work queue.
|
public long getNextTask(java.lang.String userName) throws curam.util.exception.AppException, curam.util.exception.InformationalException
My Tasks
list.
The order the search returns the tasks is determined by first checking if
the environment variable
EnvVars.ENV_WORKFLOW_RESERVENEXTTASK_WITH_PRIORITY_FILTER
is set. If it is set, then the tasks returned will be ordered by the
priorities specified in the
EnvVars.ENV_WORKFLOW_TASK_PRIORITY_ORDER
environment variable followed by the least recent task assignment date. If
the priority filter environment variable has not been set then the next
task is retrieved by the least recent task assignment date.
Exceptions are thrown under the following circumstances:
getNextTask
in interface InboxActions
userName
- The name of the user.curam.util.exception.AppException
curam.util.exception.InformationalException
public long getNextTaskFromWorkQueue(java.lang.String userName, long workQueueID) throws curam.util.exception.AppException, curam.util.exception.InformationalException
My Tasks
list.
The order the search returns the tasks is determined by first checking if
the environment variable
EnvVars.ENV_WORKFLOW_RESERVENEXTTASK_WITH_PRIORITY_FILTER
is set. If it is set, then the tasks returned will be ordered by the
priorities specified in the
EnvVars.ENV_WORKFLOW_TASK_PRIORITY_ORDER
environment variable followed by the least recent task assignment date. If
the priority filter environment variable has not been set then the next
task is retrieved by the least recent task assignment date.
Exceptions are thrown under the following circumstances:
getNextTaskFromWorkQueue
in interface InboxActions
userName
- The name of the user.workQueueID
- The identifier of the work queue from which to get the
next taskcuram.util.exception.AppException
curam.util.exception.InformationalException
public long getNextTaskFromPreferredWorkQueue(java.lang.String userName) throws curam.util.exception.AppException, curam.util.exception.InformationalException
My Tasks
list.
The operation first retrieves the identifier of the user's preferred work
queue from their Inbox preferences. If the preferred work queue has not
been set, then this function will throw the appropriate exception. If the
identifier of the preferred work queue has been specified, then this
function delegates to getNextTaskFromWorkQueue(String, long)
.
Exceptions are thrown under the following circumstances:
getNextTaskFromPreferredWorkQueue
in interface InboxActions
userName
- The name of the user whose next task from the preferred
work queue will be added to the list of tasks to work on.My Tasks
list of tasks to work on.curam.util.exception.AppException
curam.util.exception.InformationalException
public long getNextTaskFromPreferredOrgUnit(java.lang.String userName) throws curam.util.exception.AppException, curam.util.exception.InformationalException
My Tasks
list. If the preferred
organization unit has not been specified then the appropriate exception
is thrown.
The order the search returns the tasks is determined by first checking if
the environment variable
EnvVars.ENV_WORKFLOW_RESERVENEXTTASK_WITH_PRIORITY_FILTER
is set. If it is set, then the tasks returned will be ordered by the
priorities specified in the
EnvVars.ENV_WORKFLOW_TASK_PRIORITY_ORDER
environment variable followed by the least recent task assignment date. If
the priority filter environment variable has not been set then the next
task is retrieved by the least recent task assignment date.
An exception is thrown under the following circumstances:
getNextTaskFromPreferredOrgUnit
in interface InboxActions
userName
- The name of the user.curam.util.exception.AppException
curam.util.exception.InformationalException
public void subscribeUserToWorkQueue(java.lang.String userName, long workQueueID) throws curam.util.exception.AppException, curam.util.exception.InformationalException
An exception is thrown under the following circumstances:
subscribeUserToWorkQueue
in interface InboxActions
userName
- The name of the user.workQueueID
- The identifier of the work queue that the use is
subscribing to.curam.util.exception.AppException
curam.util.exception.InformationalException
public void unsubscribeUserFromWorkQueue(java.lang.String userName, long workQueueID) throws curam.util.exception.AppException, curam.util.exception.InformationalException
An exception is thrown under the following circumstances:
unsubscribeUserFromWorkQueue
in interface InboxActions
userName
- The name of the user.workQueueID
- The identifier of the work queue that the use is
un-subscribing from.curam.util.exception.AppException
curam.util.exception.InformationalException