de.aristaflow.adept2.core.worklistmanager

Interface WorklistAdministration

public interface WorklistAdministration

This interface allows the administrative supervision of the worklist manager. It enables an administrator to engage in the worklist management by providing access to all worklists including a global worklist containing all work items. These items may be manipulated, for instance, set attributes or delegate them. Therefore all objects returned by this worklist are administrative worklist objects.
One has to take care that only authorised users may call these methods. The supervisor has to be configured by the agent and organisational position ID in the configuration of the worklist manager. This information is only used to check the session token, the items in the global worklist will not be assigned to the normal worklist of this agent!

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
Worklist<? extends AdministrativeWorklistItem>	getGlobalWorklist(SessionToken session) Gets the global worklist which contains all worklist items available in this worklist manager.
Worklist<? extends AdministrativeWorklistItem>	getGlobalWorklist(SessionToken session, Filter filter) Gets the global worklist which contains all worklist items available in this worklist manager with the items filtered appropriately.
IncrementalWorklist<? extends AdministrativeWorklistItem>	getGlobalWorklistIncrementally(SessionToken session, boolean respectAggregation, boolean aggregateGroups) The same as getGlobalWorklist(SessionToken) but with a worklist providing incremental access to its items and optionally containing grouping items.
IncrementalWorklist<? extends AdministrativeWorklistItem>	getGlobalWorklistIncrementally(SessionToken session, Filter filter, boolean respectAggregation, boolean aggregateGroups) The same as getGlobalWorklist(SessionToken) but with a worklist providing incremental access to its filtered items.
Worklist<? extends AdministrativeWorklistItem>	getInternalWorklist(SessionToken session, java.util.UUID worklistID) Gets the worklist that has the designated (unique) ID.
Worklist<? extends AdministrativeWorklistItem>	getInternalWorklist(SessionToken session, java.util.UUID worklistID, Filter filter) Gets the worklist that has the designated (unique) ID with the items filtered appropriately.
IncrementalWorklist<? extends AdministrativeWorklistItem>	getInternalWorklistIncrementally(SessionToken session, java.util.UUID worklistID, boolean respectAggregation, boolean aggregateGroups) The same as getInternalWorklist(SessionToken, UUID) but with a worklist providing incremental access to its items and optionally containing grouping items.
IncrementalWorklist<? extends AdministrativeWorklistItem>	getInternalWorklistIncrementally(SessionToken session, java.util.UUID worklistID, Filter filter, boolean respectAggregation, boolean aggregateGroups) The same as getInternalWorklist(SessionToken, UUID) but with a worklist providing incremental access to its filtered items and optionally containing grouping items.
java.util.UUID	getWorklistID(SessionToken session, QualifiedAgent agent) Gets the unique ID of the (internal) worklist of the designated agent.
AdministrativeWorklistItem	getWorklistItem(SessionToken session, EBPInstanceReference activity) Gets the worklist item for the designated activity.
java.util.Map<QualifiedAgent,java.util.UUID>	getWorklistsContaining(SessionToken session, EBPInstanceReference activity) Gets the IDs of the worklists containing the designated activity and the corresponding owners of the worklists.
void	reconnectToExecutionManager(SessionToken session) Reconnects from the worklist interaction by removing and readding this worklist manager to the execution manager.
void	redistributeItems(SessionToken session, java.util.Collection<java.util.UUID> worklistItemIDs) Causes a redistribution of qualified worklist items.
void	redistributeItems(SessionToken session, java.lang.String staffAssignmentRule) Causes a redistribution of qualified worklist items.
void	redistributeItemsRegExp(SessionToken session, java.lang.String regExp) Causes a redistribution of qualified worklist items.
boolean	removeInternalWorklist(SessionToken session, java.util.UUID worklistId) Removes the designated internal worklist.

Method Detail

getWorklistID

java.util.UUID getWorklistID(SessionToken session,
                             QualifiedAgent agent)

Gets the unique ID of the (internal) worklist of the designated agent.

Parameters:

session - The session token identifying the user to get the worklist of the designated agent and the session for the retrieval process.

agent - The agent for whom to retrieve the worklist ID.

Returns:

The unique ID of the worklist of the designated agent or null if the Agent is unknown to this worklist manager.

getInternalWorklist

Worklist<? extends AdministrativeWorklistItem> getInternalWorklist(SessionToken session,
                                                                   java.util.UUID worklistID)

Gets the worklist that has the designated (unique) ID.

Parameters:

session - The session token identifying the user to get the designated internal worklist and the session for the retrieval process.

worklistID - The unique ID of the worklist to retrieve.

Returns:

The worklist having the designated ID.

getInternalWorklistIncrementally

IncrementalWorklist<? extends AdministrativeWorklistItem> getInternalWorklistIncrementally(SessionToken session,
                                                                                           java.util.UUID worklistID,
                                                                                           boolean respectAggregation,
                                                                                           boolean aggregateGroups)

The same as getInternalWorklist(SessionToken, UUID) but with a worklist providing incremental access to its items and optionally containing grouping items. Due to the incremental worklist relying on static data, group aggregation needs to be provided here and cannot be changed later.

Parameters:

session - The session token identifying the user to get the designated internal worklist and the session for the retrieval process.

worklistID - The unique ID of the worklist to retrieve.

respectAggregation - Whether the incremental worklist should respect aggregation and return either grouping or group items.

aggregateGroups - Whether the incremental worklist should aggregate item groups and return grouping items instead of the group items (items being member of a group) incrementally. Otherwise only group items but no grouping items will be returned incrementally.

Returns:

The worklist having the designated ID as incremental worklist.

getInternalWorklist

Worklist<? extends AdministrativeWorklistItem> getInternalWorklist(SessionToken session,
                                                                   java.util.UUID worklistID,
                                                                   Filter filter)

Gets the worklist that has the designated (unique) ID with the items filtered appropriately.

Parameters:

session - The session token identifying the user to get the designated internal worklist and the session for the retrieval process.

worklistID - The unique ID of the worklist to retrieve.

filter - The filter which to apply to the items in the worklist.

Returns:

The worklist having the designated ID.

getInternalWorklistIncrementally

IncrementalWorklist<? extends AdministrativeWorklistItem> getInternalWorklistIncrementally(SessionToken session,
                                                                                           java.util.UUID worklistID,
                                                                                           Filter filter,
                                                                                           boolean respectAggregation,
                                                                                           boolean aggregateGroups)

The same as getInternalWorklist(SessionToken, UUID) but with a worklist providing incremental access to its filtered items and optionally containing grouping items. Due to the incremental worklist relying on static data, group aggregation needs to be provided here and cannot be changed later.

Parameters:

session - The session token identifying the user to get the designated internal worklist and the session for the retrieval process.

worklistID - The unique ID of the worklist to retrieve.

filter - The filter which to apply to the items in the worklist.

respectAggregation - Whether the incremental worklist should respect aggregation and return either grouping or group items.

aggregateGroups - Whether the incremental worklist should aggregate item groups and return grouping items instead of the group items (items being member of a group) incrementally. Otherwise only group items but no grouping items will be returned incrementally.

Returns:

The worklist having the designated ID as incremental worklist optionally including grouping items.

getGlobalWorklist

Worklist<? extends AdministrativeWorklistItem> getGlobalWorklist(SessionToken session)

Gets the global worklist which contains all worklist items available in this worklist manager.

Parameters:

session - The session token identifying the user to get the global worklist, to check for the necessary access and the session for the retrieval process.

Returns:

The global worklist which contains all worklist items currently by this worklist manager.

getGlobalWorklistIncrementally

IncrementalWorklist<? extends AdministrativeWorklistItem> getGlobalWorklistIncrementally(SessionToken session,
                                                                                         boolean respectAggregation,
                                                                                         boolean aggregateGroups)

The same as getGlobalWorklist(SessionToken) but with a worklist providing incremental access to its items and optionally containing grouping items. Due to the incremental worklist relying on static data, group aggregation needs to be provided here and cannot be changed later.

Parameters:

session - The session token identifying the user to get the global worklist, to check for the necessary access and the session for the retrieval process.

respectAggregation - Whether the incremental worklist should respect aggregation and return either grouping or group items.

aggregateGroups - Whether the incremental worklist should aggregate item groups and return grouping items instead of the group items (items being member of a group) incrementally. Otherwise only group items but no grouping items will be returned incrementally.

Returns:

The global worklist which contains all worklist items currently by this worklist manager as incremental worklist optionally including grouping items.

getGlobalWorklist

Worklist<? extends AdministrativeWorklistItem> getGlobalWorklist(SessionToken session,
                                                                 Filter filter)

Gets the global worklist which contains all worklist items available in this worklist manager with the items filtered appropriately.

Parameters:

session - The session token identifying the user to get the global worklist, to check for the necessary access and the session for the retrieval process.

filter - The filter which to apply to the items in the worklist.

Returns:

The global worklist which contains all worklist items currently by this worklist manager.

getGlobalWorklistIncrementally

IncrementalWorklist<? extends AdministrativeWorklistItem> getGlobalWorklistIncrementally(SessionToken session,
                                                                                         Filter filter,
                                                                                         boolean respectAggregation,
                                                                                         boolean aggregateGroups)

The same as getGlobalWorklist(SessionToken) but with a worklist providing incremental access to its filtered items. Due to the incremental worklist relying on static data, group aggregation needs to be provided here and cannot be changed later.

Parameters:

session - The session token identifying the user to get the global worklist, to check for the necessary access and the session for the retrieval process.

filter - The filter which to apply to the items in the worklist.

respectAggregation - Whether the incremental worklist should respect aggregation and return either grouping or group items.

aggregateGroups - Whether the incremental worklist should aggregate item groups and return grouping items instead of the group items (items being member of a group) incrementally. Otherwise only group items but no grouping items will be returned incrementally.

Returns:

The global worklist which contains all worklist items currently by this worklist manager as incremental worklist.

getWorklistsContaining

java.util.Map<QualifiedAgent,java.util.UUID> getWorklistsContaining(SessionToken session,
                                                                    EBPInstanceReference activity)

Gets the IDs of the worklists containing the designated activity and the corresponding owners of the worklists.

Parameters:

session - The session token identifying the user to get the worklists containing a specific worklist item.

activity - The activity to get the worklists containing the corresponding worklist item.

Returns:

The agents whose worklists contain the designated activity mapped to the corresponding worklist IDs. This will be an empty map in case the designated activity does not have a worklist item.

getWorklistItem

AdministrativeWorklistItem getWorklistItem(SessionToken session,
                                           EBPInstanceReference activity)

Gets the worklist item for the designated activity.

Parameters:

session - The session token identifying the user to get the worklist item for a specific activity.

activity - The activity to get the worklists item for.

Returns:

The worklist item for the designated activity or null in case the designated activity does not have a worklist item.

redistributeItems

void redistributeItems(SessionToken session,
                       java.lang.String staffAssignmentRule)

Causes a redistribution of qualified worklist items. Only worklist items qualify, that are not assigned, delegated or enquired. Additionally, their staff assignment rule has to contain the designated staff assignment rule literally.
Use this method carefully! It has serious effects on the performance of the worklist manager. Therefore this method usually runs concurrently and thus the calling thread will return before the redistribution completed.

Parameters:

session - The session which is used to check for access rights on this method. If the redistribution is done asynchronously, it may use a completely different session.

staffAssignmentRule - The staff assignment rule that has to be part of the staff assignment rule of a worklist item for the worklist item to qualify for redistribution. The designated string has to be a literal part of the staff assignment rule of the worklist item. It does not suffice that it refers to the same entities of the organisational model.

redistributeItemsRegExp

void redistributeItemsRegExp(SessionToken session,
                             java.lang.String regExp)

Causes a redistribution of qualified worklist items. Only worklist items qualify, that are not assigned, delegated or enquired. Additionally, their staff assignment rule has to match the designated regular expression (according to Pattern).
Use this method carefully! It has serious effects on the performance of the worklist manager. Therefore this method usually runs concurrently and thus the calling thread will return before the redistribution completed.

Parameters:

session - The session which is used to check for access rights on this method. If the redistribution is done asynchronously, it may use a completely different session.

regExp - The regular expression (according to Pattern) a staff assignment has to match to qualify for redistribution.

See Also:

Pattern

redistributeItems

void redistributeItems(SessionToken session,
                       java.util.Collection<java.util.UUID> worklistItemIDs)

Causes a redistribution of qualified worklist items. Only worklist items qualify, that are not assigned or enquired. Additionally, their IDs must be contained in the designated collection of worklist IDs. Delegated items as well as escalated items will get redistributed! The delegation history will be dropped. This differs from the behaviour of redistributeItems(SessionToken, String). Absent agents (without substitution) will not qualify for a redistributed item, that is, redistributed items may be removed from the worklist of an absent agent.
Use this method carefully! It has serious effects on the performance of the worklist manager. Therefore this method usually runs concurrently and thus the calling thread will return before the redistribution completed.

Parameters:

session - The session which is used to check for access rights on this method. If the redistribution is done asynchronously, it may use a completely different session.

worklistItemIDs - The collection of IDs of worklist items that should be redistributed.

removeInternalWorklist

boolean removeInternalWorklist(SessionToken session,
                               java.util.UUID worklistId)

Removes the designated internal worklist. The worklist has to be empty and the corresponding agent must not be logged on at a client.

Parameters:

session - The session which is used to check for access rights on this method.

worklistId - The ID of the worklist which to remove from this worklist manager.

Returns:

Whether removing has been successful, e.g. deleting a non-empty worklist will never be successful.

reconnectToExecutionManager

void reconnectToExecutionManager(SessionToken session)
                          throws ReconnectionFailedException

Reconnects from the worklist interaction by removing and readding this worklist manager to the execution manager.

Parameters:

session - The session which is used to check for access rights on this method.

Throws:

ReconnectionFailedException - If reconnecting fails, a ReconnectionFailedException will be thrown.