de.aristaflow.adept2.core.worklistmanager

Interface DelegationManager

All Known Subinterfaces:

EscalationHandling.EscalationMeasures

public interface DelegationManager

Delegation allows to assign another user as the currently assigned one. To support this, the user is offered a list of potential recipients of the delegation, chooses one or more of them and finally reassigns the worklist item.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
void	delegateBack(SessionToken session, WorklistItem item, java.lang.String reply) Delegates the worklist item to the prior delegating agent and sets the designated reply as delegation comment.
void	delegateWorkItem(SessionToken session, WorklistItem item, java.util.Set<QualifiedAgent> recipients, java.lang.String comment) Delegates the designated worklist item to the designated recipients, that is, the worklist item is assigned to all worklists of the designated recipients and removed from the current worklists.
java.util.Set<QualifiedAgent>	getDelegationRecipients(SessionToken session, WorklistItem item) Gets all possible delegation recipients for the designated worklist item and for the designated delegating agent identified by the session token.
RemoteIterator<java.util.List<QualifiedAgent>>	getDelegationRecipientsIterator(SessionToken session, WorklistItem item) The same as getDelegationRecipients(SessionToken, WorklistItem) but with partial retrieval of the agents.

Method Detail

getDelegationRecipients

java.util.Set<QualifiedAgent> getDelegationRecipients(SessionToken session,
                                                      WorklistItem item)

Gets all possible delegation recipients for the designated worklist item and for the designated delegating agent identified by the session token.

Parameters:

session - The session token identifying the user to get the delegation recipients and the session for the retrieval process.

item - The worklist item to reassign and to determine the delegation recipients of. A grouping item cannot be delegated and therefore returns the empty set.

Returns:

A collection of agents to whom the delegating agent may delegate the designated worklist item.

getDelegationRecipientsIterator

RemoteIterator<java.util.List<QualifiedAgent>> getDelegationRecipientsIterator(SessionToken session,
                                                                               WorklistItem item)

The same as getDelegationRecipients(SessionToken, WorklistItem) but with partial retrieval of the agents.

Parameters:

session - The session token identifying the user to get the delegation recipients and the session for the retrieval process.

item - The worklist item to reassign and to determine the delegation recipients of. A grouping item cannot be delegated and therefore returns the empty set.

Returns:

An iterator providing the agents to whom the delegating agent may delegate the designated worklist item.

delegateWorkItem

void delegateWorkItem(SessionToken session,
                      WorklistItem item,
                      java.util.Set<QualifiedAgent> recipients,
                      java.lang.String comment)
               throws InvalidWorklistItemStateException

Delegates the designated worklist item to the designated recipients, that is, the worklist item is assigned to all worklists of the designated recipients and removed from the current worklists. This also adapts the delegation level of the worklist item ( WorklistItem.getCurrentDelegationLevel()) accordingly. If the designated worklist item is selected by the delegator, it will be deselected before delegation. The delegation recipient starting/resuming the item implicitly selects it. This removes the item from the worklists of the other recipients.
The adaptation of the worklist usually requires InternalWorklistItems. So this method needs access to an internal worklist item based on the corresponding worklist item.

Parameters:

session - The session token identifying the user to delegate the worklist item and the session for the delegation process.

item - The worklist item that is to be removed from the current worklists and added to the worklists of the designated recipients. This must not be a grouping item. Such an item will lead to an IllegalArgumentException.

recipients - The recipients to whose worklists the designated worklist item is added.

comment - A comment for the delegator why this item has been delegated. This is optional and may therefore be null.

Throws:

InvalidWorklistItemStateException - If the worklist item is enquired, or it is selected and cannot be deselected or is running and cannot be suspended, an InvalidWorklistItemStateException will be thrown.

delegateBack

void delegateBack(SessionToken session,
                  WorklistItem item,
                  java.lang.String reply)
           throws InvalidWorklistItemStateException

Delegates the worklist item to the prior delegating agent and sets the designated reply as delegation comment. This method is a convenience method for delegateWorkItem(SessionToken, WorklistItem, Set, String) with an implicit delegation receiver.

While enquiring is nested (stack-based) delegation is consecutive (list-based). Therefore delegating back leads to another level of delegation.

Parameters:

session - The session token identifying the user to delegate the worklist item back and the session for the delegation process.

item - The worklist item that is to be added to the worklist of the delegating agent. This must not be a grouping item. Such an item will lead to an IllegalArgumentException.

reply - The reply message sent by the delegation receiver for the delegating agent. This corresponds to the delegation comment.

Throws:

InvalidWorklistItemStateException - If the worklist item is enquired, or it is selected and cannot be deselected or is running and cannot be suspended, an InvalidWorklistItemStateException will be thrown.