curam.core.facade.intf

Interface Inbox

All Known Implementing Classes:

Inbox, curam.core.facade.impl.Inbox, InboxFactory

@AccessLevel(value=EXTERNAL)
public interface Inbox

Tasks are used to assign and track the work of system users. The Inbox is used by the users of the Curam application to manage their tasks. This class provides the operations used to list, view and retrieve tasks to work on in the Inbox.

Method Summary

Modifier and Type	Method and Description
curam.core.sl.struct.InboxOptionsPreferencesDetails	getInboxOptionsUserPreferences() Returns the Inbox options user preferences for the user.
curam.core.sl.struct.TaskRedirectionSecurity	getTaskRedirectionAndBlockingSecurity() Returns the user's security settings for viewing and editing their task redirection and allocation blocking settings.
curam.core.facade.struct.ListAssignedTaskDetails	listAssigned(curam.core.facade.struct.ListTaskKey listTaskKey) Returns a list of the task details including the task deadline for tasks that are assigned directly to a user but not currently reserved by the user.
curam.core.sl.struct.TaskQueryResultDetailsList	listAvailableTasks() Returns a list all the tasks that are assigned the current user and thus available to work on.
curam.core.facade.struct.LimitedListDeferredTaskDetails	listLimitedDeferredTasks() Returns a list of the task details that have been deferred by the current user.
curam.core.facade.struct.LimitedListReservedTaskDetails	listLimitedReservedTasks() Returns a list all the tasks that are reserved by the current user.
curam.core.facade.struct.LimitedListReservedTaskDetails	listLimitedReservedTasksByStatus(curam.core.facade.struct.ListReservedByStatusKey listReservedByStatusKey) Returns a list all the tasks that are reserved by the current user and filtered by task status (e.g.
curam.core.facade.struct.LimitedListWorkQueueUnreservedTasksDetails	listLimitedUnreservedWorkQueueTasks(curam.core.facade.struct.ListWorkQueueUnreservedTasksKey key) Returns a list of tasks that are unreserved (and thus available to be worked on) for the specified work queue.
curam.core.facade.struct.ListReservedByPriorityDetails	listReservedByPriority(curam.core.facade.struct.ListReservedByPriorityKey listReservedByPriorityKey) Returns a list of all of the tasks that are reserved by the current user and are filtered by task priority (e.g.
curam.core.facade.struct.ListReservedDueOnDateDetails	listReservedDueOnDate(curam.core.facade.struct.ListReservedKey listReservedKey) Returns a list of all the task details that are reserved by a specified user and are due on a specified date.
curam.core.facade.struct.ListReservedDueOnOrBeforeDateDetails	listReservedDueOnOrBeforeDate(curam.core.facade.struct.ListReservedKey listReservedKey) Returns a list of all the tasks that are reserved by a specified user and are due on or before a specified date.
curam.core.facade.struct.InboxContextDescription	readContextDescription(curam.core.facade.struct.ListTaskKey listTaskKey) Returns the context description for specified inbox.
curam.core.facade.struct.ReserveNextTaskDetails	reserveNextTask(curam.core.facade.struct.ReserveNextTaskKey reserveNextTaskKey) Adds the next task available for the specified user to the their list of tasks to work on.
curam.core.facade.struct.ReserveNextTaskDetails	reserveNextTaskFromPreferredOrgUnit(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey) Adds the next task to the list of tasks to work on from the user's preferred organization unit.
curam.core.facade.struct.ReserveNextTaskDetails	reserveNextTaskFromPreferredWorkQueue(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey) Adds the next task to the list of available tasks to work on from the user's preferred work queue.
curam.core.facade.struct.ReserveNextTaskDetails	reserveNextWorkQueueTask(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey) Adds the next task to the list of tasks to work on from the specified work queue which the specified user is subscribed to.
curam.core.struct.AvailableTaskSearchResult	searchAvailableTasks() This method searches for available tasks for the currently logged in user using the search criteria stored for the user in the database.
curam.core.sl.struct.TaskQueryResultDetailsList	searchForTasks(curam.core.sl.struct.TaskQueryKey searchTaskKey) Searches for tasks based on specified criteria.
curam.core.facade.struct.ListWorkQueueNameDtls	searchWorkQueueName(curam.core.facade.struct.ListTaskKey listTaskKey) Returns a list of all the work queue names and identifiers that the current user is subscribed to.
curam.core.facade.struct.ListUserOrgObjectWorkQueueDetails	searchWorkQueues(curam.core.facade.struct.ListTaskKey listTaskKey) Returns two list of all the work queue names and identifiers that the current user is subscribed to.
void	setInboxOptionsUserPreferences(curam.core.sl.struct.InboxUserPreferenceDetails preferences) Sets the current users inbox options preferences.
void	subscribeUserWorkQueue(curam.core.facade.struct.SubscribeUserWorkQueueKey subscribeUserWorkQueueKey) Subscribes the specified user to the specified work queue.
void	unsubscribeUserWorkQueue(curam.core.facade.struct.UnsubscribeUserWorkQueueKey unsubscribeUserWorkQueueKey) Un-subscribes the specified user from the specified work queue.
curam.core.sl.struct.InboxOptionsSummaryDetails	viewInboxOptionsSummaryForUser() Returns the inbox options summary for the currently logged on user.

Method Detail

listReservedByPriority

curam.core.facade.struct.ListReservedByPriorityDetails listReservedByPriority(curam.core.facade.struct.ListReservedByPriorityKey listReservedByPriorityKey)
                                                                       throws curam.util.exception.AppException,
                                                                              curam.util.exception.InformationalException

Returns a list of all of the tasks that are reserved by the current user and are filtered by task priority (e.g. High, Medium, Low).

The tasks are ordered by deadline date time, earliest first.

Parameters:

listReservedByPriorityKey - The task priority used to filter the search results.

Returns:

A list of all the tasks that have been reserved by the current user filtered by the specified task priority.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReservedDueOnDate

curam.core.facade.struct.ListReservedDueOnDateDetails listReservedDueOnDate(curam.core.facade.struct.ListReservedKey listReservedKey)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Returns a list of all the task details that are reserved by a specified user and are due on a specified date.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Parameters:

listReservedKey - The name of the user whose reserved task details will be returned.

Returns:

A list of all the task details that are reserved by a specified user and are due on a specified date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReservedDueOnOrBeforeDate

curam.core.facade.struct.ListReservedDueOnOrBeforeDateDetails listReservedDueOnOrBeforeDate(curam.core.facade.struct.ListReservedKey listReservedKey)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of all the tasks that are reserved by a specified user and are due on or before a specified date.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Parameters:

listReservedKey - The name of the user whose reserved task details will be returned.

Returns:

A list of all the task details that are reserved by a specified user and are due on or before a specified date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAssigned

curam.core.facade.struct.ListAssignedTaskDetails listAssigned(curam.core.facade.struct.ListTaskKey listTaskKey)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Returns a list of the task details including the task deadline for tasks that are assigned directly to a user but not currently reserved by the user. This list does not include tasks assigned to work queues to which the user is subscribed nor those assigned to organization objects, positions or jobs that the user is part of.

By default the list is ordered by deadline with the least recent deadline first.

if the ENV_WORKFLOW_SORTINBOXTASKS_WITH_PRIORITY_FILTER environment variable is set to true, the tasks are sorted by priority. The priority ordering is determined by the environment variable ENV_WORKFLOW_TASK_PRIORITY_ORDER. The value of this variable is a comma delimited string containing the task priority code table values with the highest priority first.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserveNextTask

curam.core.facade.struct.ReserveNextTaskDetails reserveNextTask(curam.core.facade.struct.ReserveNextTaskKey reserveNextTaskKey)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Adds the next task available for the specified user to the their list of tasks to work on. The system 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 users 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:

• If there are no tasks assigned to the user.

Parameters:

reserveNextTaskKey - The name of the user.

Returns:

The identifier of the next task that was added to the user's list of tasks to work on.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserveNextWorkQueueTask

curam.core.facade.struct.ReserveNextTaskDetails reserveNextWorkQueueTask(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

Adds the next task to the list of tasks to work on from the specified work queue which the specified user is subscribed to. The system 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.

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:

• If there are no tasks available to be added from the specified work queue.

Parameters:

reserveNextWorkQueueTaskKey - The name of the user and identifier of the work queue.

Returns:

The identifier of the next task that was added to the user's list of tasks to work on.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextDescription

curam.core.facade.struct.InboxContextDescription readContextDescription(curam.core.facade.struct.ListTaskKey listTaskKey)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

Returns the context description for specified inbox. In this case, the context is the user name.

Parameters:

listTaskKey - The user name specified in this struct will be returned. If no user name has been specified, then the name of the currently logged in user will be returned.

Returns:

The context for the current Inbox.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

subscribeUserWorkQueue

void subscribeUserWorkQueue(curam.core.facade.struct.SubscribeUserWorkQueueKey subscribeUserWorkQueueKey)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Subscribes the specified user to the specified work queue.

An exception is thrown under the following circumstances:

• If the user cannot subscribe to the work queue.
• If the user is already subscribed to the work queue.

Parameters:

subscribeUserWorkQueueKey - The name of the user and the identifier of the work queue to subscribe to.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

unsubscribeUserWorkQueue

void unsubscribeUserWorkQueue(curam.core.facade.struct.UnsubscribeUserWorkQueueKey unsubscribeUserWorkQueueKey)
                       throws curam.util.exception.AppException,
                              curam.util.exception.InformationalException

Un-subscribes the specified user from the specified work queue. An exception is thrown under the following circumstances:

• If the work queue does not allow users to subscribe or un-subscribe from that work queue as it is an administration function.

Parameters:

unsubscribeUserWorkQueueKey - The name of the user and the identifier of the work queue to un-subscribe from.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchAvailableTasks

curam.core.struct.AvailableTaskSearchResult searchAvailableTasks()
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

This method searches for available tasks for the currently logged in user using the search criteria stored for the user in the database. The criteria that can be used in the search can be a combination of the following:

• Zero or more organization objects (organization objects, positions and jobs) who the currently logged on user is a member of, the user or work queues that the user is subscribed to
• Zero or more Task Priorities
• Zero or more task Deadline Due ranges

The search is performed by the SearchTask interface. The default search implementation can be customized using Guice and by extending SearchTaskImpl.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of available tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewInboxOptionsSummaryForUser

curam.core.sl.struct.InboxOptionsSummaryDetails viewInboxOptionsSummaryForUser()
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Returns the inbox options summary for the currently logged on user.

Returns:

The details on whether task redirection or allocation blocking is turned on or off. If task redirection is on then the full name of the user or organization object for the task redirection is also included.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getInboxOptionsUserPreferences

curam.core.sl.struct.InboxOptionsPreferencesDetails getInboxOptionsUserPreferences()
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Returns the Inbox options user preferences for the user. The user preferences are comprised of the preferred work queue and preferred organization unit the user has set for their Inbox actions. These are retrieved from the user preferences of the user. A list of all the organization units that the user is part of and a list of all the work queues that the user is subscribed to is also returned.

Returns:

The Inbox options user preferences for the current user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

setInboxOptionsUserPreferences

void setInboxOptionsUserPreferences(curam.core.sl.struct.InboxUserPreferenceDetails preferences)
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

Sets the current users inbox options preferences. These preferences include the user's preferred work queue and user's preferred organization unit.

Parameters:

preferences - The preferences to set.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getTaskRedirectionAndBlockingSecurity

curam.core.sl.struct.TaskRedirectionSecurity getTaskRedirectionAndBlockingSecurity()
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Returns the user's security settings for viewing and editing their task redirection and allocation blocking settings. If the required security settings have been specified, then the user will be able to set and maintain their own task redirection and task allocation blocking periods.

See the Workflow Reference Guide for more details on the security settings that this function examines in order to determine these security settings.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchForTasks

curam.core.sl.struct.TaskQueryResultDetailsList searchForTasks(curam.core.sl.struct.TaskQueryKey searchTaskKey)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Searches for tasks based on specified criteria. The criteria are those which may be specified when building a task query in the Inbox. The search is performed by the SearchTask interface. The default search implementation can be customized using Guice and by extending SearchTaskImpl.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of tasks based on the search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchWorkQueues

curam.core.facade.struct.ListUserOrgObjectWorkQueueDetails searchWorkQueues(curam.core.facade.struct.ListTaskKey listTaskKey)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Returns two list of all the work queue names and identifiers that the current user is subscribed to. One list returned includes work queues that the user is directly subscribed to. The second list includes those work queues that the user is indirectly subscribed to (by virtue of being a member of an organization unit, position or job that the current user is a member of). Both lists include a count of the tasks assigned to the specified work queues. An informational message is returned if the user is not subscribed to any work queue.

Parameters:

listTaskKey - The user name.

Returns:

The lists of work queue names and identifiers.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchWorkQueueName

curam.core.facade.struct.ListWorkQueueNameDtls searchWorkQueueName(curam.core.facade.struct.ListTaskKey listTaskKey)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Returns a list of all the work queue names and identifiers that the current user is subscribed to. The list returned includes work queues that the user is subscribed to and also those that the user is indirectly subscribed to (by virtue of being a member of an organization unit, position or job that the current user is a member of). An informational message is returned if the user is not subscribed to any work queue.

Parameters:

listTaskKey - The user name.

Returns:

The list of work queue names and identifiers.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLimitedReservedTasks

curam.core.facade.struct.LimitedListReservedTaskDetails listLimitedReservedTasks()
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns a list all the tasks that are reserved by the current user.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of tasks that are reserved by the current user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLimitedReservedTasksByStatus

curam.core.facade.struct.LimitedListReservedTaskDetails listLimitedReservedTasksByStatus(curam.core.facade.struct.ListReservedByStatusKey listReservedByStatusKey)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Returns a list all the tasks that are reserved by the current user and filtered by task status (e.g. OPEN, DEFERRED).

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of tasks that are reserved by the current user filtered by the task status.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLimitedUnreservedWorkQueueTasks

curam.core.facade.struct.LimitedListWorkQueueUnreservedTasksDetails listLimitedUnreservedWorkQueueTasks(curam.core.facade.struct.ListWorkQueueUnreservedTasksKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns a list of tasks that are unreserved (and thus available to be worked on) for the specified work queue.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of tasks that are reserved by the current user filtered by the task status.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listLimitedDeferredTasks

curam.core.facade.struct.LimitedListDeferredTaskDetails listLimitedDeferredTasks()
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns a list of the task details that have been deferred by the current user.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is displayed (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

The tasks are ordered by deadline date time, earliest first.

Returns:

A list of the task details that have been deferred by the current user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAvailableTasks

curam.core.sl.struct.TaskQueryResultDetailsList listAvailableTasks()
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Returns a list all the tasks that are assigned the current user and thus available to work on. This includes the tasks assigned directly to the user, those assigned to organization units, positions and jobs that the user is part of and also those assigned to work queues that the user is subscribed to.

The number of tasks that returned may be limited. This may be changed by altering the ENV_INBOX_MAX_TASK_LIST_SIZE application property. The default is 100. If the number of records exceeds the specified maximum value then an informational message is returned (INF_READMULTI_MAX_EXCEEDED) informing the user that more records exist.

By default the returned tasks are ordered deadline time in ascending order using the sort class TaskSortByDeadlineAscending. The sort order can be changed by using Guice to bind TaskSort to another sort class.

Returns:

The list of available tasks for the user.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserveNextTaskFromPreferredWorkQueue

curam.core.facade.struct.ReserveNextTaskDetails reserveNextTaskFromPreferredWorkQueue(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Adds the next task to the list of available tasks to work on from the user's preferred work queue. The method 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 InboxActions.getNextTaskFromWorkQueue(String, long).

Exceptions are thrown under the following circumstances:

• If the preferred work queue Inbox preference has not been set.
• If the user is not subscribed to the specified work queue.
• If there are no tasks available to be added from the specified work queue.

Parameters:

reserveNextWorkQueueTaskKey - The name of the user whose next task from the preferred work queue will be added to the list of tasks to work on.

Returns:

The identifier of the next task that was added to the user's My Tasks list of tasks to work on.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reserveNextTaskFromPreferredOrgUnit

curam.core.facade.struct.ReserveNextTaskDetails reserveNextTaskFromPreferredOrgUnit(curam.core.facade.struct.ReserveNextWorkQueueTaskKey reserveNextWorkQueueTaskKey)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Adds the next task to the list of tasks to work on from the user's preferred organization unit. The method retrieves the user's preferred organization unit from their Inbox preferences. If the 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:

• If the user has no preferred organization unit specified in their Inbox preferences.
• If there are no tasks available to be added from the specified organization unit.

Parameters:

reserveNextWorkQueueTaskKey - The name of the user.

Returns:

The identifier of the next task that was added to the user's list of tasks to work on.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException