de.aristaflow.adept2.core.worklistmanager

Interface DistributionHandling

public interface DistributionHandling

This interface allows to provide special distribution handling procedures. They are used to distribute work items to different agents, for instance, based on the current work load, the estimated time of completion,...
To support arbitrary user-defined procedures, they are identified by a (unique) name which has to correspond to the distribution procedure ID provided by a certain work item.
The procedure is called when distributing a work item to worklists or redistributing an item due to a reject or a longterm logoff.
Implementations of this interface must not assign worklist items by calling the corresponding methods of the worklist or worklist items!

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
java.util.Set<QualifiedAgent>	distribute(SessionToken session, WorklistItem item, java.util.Map<QualifiedAgent,Worklist<? extends WorklistItem>> worklists) Distributes the designated worklist item among the designated agents (stored as keys in the map) and returns a collection of chosen agents for assignment of the worklist item.
java.lang.String	getID() Gets the (unique) name of the distribution handling procedure which is used to choose the right procedure for a certain worklist item.
java.util.Set<QualifiedAgent>	redistribute(SessionToken session, WorklistItem rejectedItem, Worklist<WorklistItem> worklist, java.util.Map<QualifiedAgent,Worklist<? extends WorklistItem>> worklists) (Re-)Distributes the designated worklist item among the designated agents (stored as keys in the map) ignoring the owner of the designated worklist and returns a collection of chosen agents for assignment of the worklist item.

Method Detail

getID

java.lang.String getID()

Gets the (unique) name of the distribution handling procedure which is used to choose the right procedure for a certain worklist item.

Returns:

The (unique) name of the distribution handling procedure.

distribute

java.util.Set<QualifiedAgent> distribute(SessionToken session,
                                         WorklistItem item,
                                         java.util.Map<QualifiedAgent,Worklist<? extends WorklistItem>> worklists)

Distributes the designated worklist item among the designated agents (stored as keys in the map) and returns a collection of chosen agents for assignment of the worklist item. The distribution may be done arbitrarily, for instance, load balanced, round-robin or even randomly.
This method just evaluates the distribution but does not actually assign worklist items by calling the corresponding methods.

Parameters:

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

item - The worklist item to be distributed.

worklists - An unmodifiable map containing the potential receivers of the worklist items as keys and their worklists as entries.

Returns:

A collection of agents to assign the worklist item to or an empty collection if no valid agent could be determined. This will assign a process supervisor.

redistribute

java.util.Set<QualifiedAgent> redistribute(SessionToken session,
                                           WorklistItem rejectedItem,
                                           Worklist<WorklistItem> worklist,
                                           java.util.Map<QualifiedAgent,Worklist<? extends WorklistItem>> worklists)

(Re-)Distributes the designated worklist item among the designated agents (stored as keys in the map) ignoring the owner of the designated worklist and returns a collection of chosen agents for assignment of the worklist item. The distribution may be done arbitrarily, for instance, load balanced, round-robin or even randomly. This method is called when an agent/a client rejects a specific work item or the agent logs off for a long time and the items on the worklist need to be redistributed.
This method just evaluates the distribution but does not actually assign worklist items by calling the corresponding methods.

Parameters:

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

rejectedItem - The worklist item that has been rejected and needs to be (re-)distributed.

worklist - The worklist of the agent that has rejected the worklist item.

worklists - An unmodifiable map containing the potential receivers of the worklist items as keys and their worklists as entries.

Returns:

A list of agents to assign the rejected worklist item to or an empty list if no valid agent could be determined. This will assign a process supervisor.