de.aristaflow.adept2.core.worklistmanager

Interface WorklistManager

All Superinterfaces:

ADEPT2Service

public interface WorklistManager
extends ADEPT2Service

Worklists provide the user with the current process steps (aka. worklist items) that are to be executed. They are managed by this interface which handles logon and logoff of users, updating worklist according to the progression of the process instances as well as delegation (forwarding of worklist items to other users) and escalation (mechanism like raising priority or forwarding to a supervisor in case of overdue items.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_TYPE_DELEGATION_HANDLING Plug-in type name for delegation handling.
static java.lang.String	PLUGIN_TYPE_ESCALATION_HANDLING Plug-in type name for escalation handling.

Method Summary

Modifier and Type	Method and Description
WorklistAdministration	getAdministration() Gets the interface for administrating this worklist manager.
DelegationManager	getDelegationManager() Gets the delegation manager which allows to retrieve potential recipients for the delegation and to delegate a specific worklist item.
java.net.URI[]	getOrgModelManager(SessionToken session) Gets (the URIs of) the organisational model manager that is associated with this worklist manager.
java.util.Map<java.lang.String,java.lang.String>	getWorklistConfiguration(SessionToken session, java.util.UUID worklistID) Gets the configuration for the designated worklist, that is information on the displayed columns, the order and the width of the columns, applied filters,...
WorklistUpdateManager	getWorklistUpdateManager() Gets the worklist update manager which handles the interaction between a worklist server and a worklist client which includes retrieval of worklists and worklist updates, registering for pushed updates and changing worklist items.
void	logoff(SessionToken session) Deregisters the agent identified by the designated session token from the client machine also identified by the designated session token.
java.util.UUID	logon(SessionToken session) Logs an agent with an appropriate organisational position on, stores the corresponding client URIs and returns the UUID of the corresponding worklist.
void	setWorklistConfiguration(SessionToken session, java.util.UUID worklistID, java.util.Map<java.lang.String,java.lang.String> worklistConfiguration) Sets or updates the configuration for the designated worklist with the designated configuration values.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Field Detail

PLUGIN_TYPE_ESCALATION_HANDLING

static final java.lang.String PLUGIN_TYPE_ESCALATION_HANDLING

Plug-in type name for escalation handling.

See Also:

Constant Field Values

PLUGIN_TYPE_DELEGATION_HANDLING

static final java.lang.String PLUGIN_TYPE_DELEGATION_HANDLING

Plug-in type name for delegation handling.

See Also:

Constant Field Values

Method Detail

logon

java.util.UUID logon(SessionToken session)

Logs an agent with an appropriate organisational position on, stores the corresponding client URIs and returns the UUID of the corresponding worklist. All information (agent, organisational position and client URI are provided by the session token.
The session token is provided by authenticating at the corresponding security manager.

Parameters:

session - Identifies the agent to log on, the appropriate organisational position and the URIs of the client machine where the agent is located.

Returns:

The UUID of the worklist of the designated agent.

logoff

void logoff(SessionToken session)

Deregisters the agent identified by the designated session token from the client machine also identified by the designated session token. The agent will not receive worklist updates any more; client worklists are deregistered.

Parameters:

session - The session token identifying the agent and the corresponding client machine to log off and the session for the logoff process.

getWorklistConfiguration

java.util.Map<java.lang.String,java.lang.String> getWorklistConfiguration(SessionToken session,
                                                                          java.util.UUID worklistID)

Gets the configuration for the designated worklist, that is information on the displayed columns, the order and the width of the columns, applied filters,...

Parameters:

session - The session which is used to access the organisational model manager. This is just used as a coarse check for the necessary access rights.

worklistID - The UUID of the worklist to retrieve the configuration of.

Returns:

A map containing the configuration for the worklist, for instance the displayed columns, the ordering of items,... This must not be null!

setWorklistConfiguration

void setWorklistConfiguration(SessionToken session,
                              java.util.UUID worklistID,
                              java.util.Map<java.lang.String,java.lang.String> worklistConfiguration)

Sets or updates the configuration for the designated worklist with the designated configuration values.

Parameters:

session - The session which is used to access the organisational model manager. This is just used as a coarse check for the necessary access rights.

worklistID - The UUID of the worklist to set the configuration of.

worklistConfiguration - A map containing the configuration for the worklist, for instance the displayed columns, the ordering of items,...

getWorklistUpdateManager

WorklistUpdateManager getWorklistUpdateManager()

Gets the worklist update manager which handles the interaction between a worklist server and a worklist client which includes retrieval of worklists and worklist updates, registering for pushed updates and changing worklist items.

Returns:

The worklist update manager for the interaction between worklist server and worklist client.

getDelegationManager

DelegationManager getDelegationManager()

Gets the delegation manager which allows to retrieve potential recipients for the delegation and to delegate a specific worklist item.

Returns:

The delegation manager to delegate worklist items to other users (if this is allowed).

getAdministration

WorklistAdministration getAdministration()

Gets the interface for administrating this worklist manager. This supports retrieval of arbitrary worklists including a global worklist which holds all worklist items known to this worklist manager. It has to be ensured that no unauthorised access is possible.

Returns:

The interface for administrating this worklist manager by providing access to all worklist items.

getOrgModelManager

java.net.URI[] getOrgModelManager(SessionToken session)

Gets (the URIs of) the organisational model manager that is associated with this worklist manager.

Parameters:

session - The session which is used to access the organisational model manager. This is just used as a coarse check for the necessary access rights.

Returns:

The URIs to the manager for the organisational model used by this worklist manager.