de.aristaflow.adept2.core.worklistmanager

Interface EscalationHandling

public interface EscalationHandling

This interface supports user-defined escalation handling procedures. An implementing class is notified when a deadline has been reached. Based on the worklist item, the deadline and the access to EscalationMeasures, arbitrary escalation handling is supported.
Each escalation handling procedure is identified by a (unique) name. This name is also found in the worklist items.

Author:

Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EscalationHandling.EscalationMeasures EscalationMeasures provides the means to escalate a worklist item accordingly (and prevents accessing arbitrary functions of the worklist manager).

Method Summary

Modifier and Type	Method and Description
void	deadlineReached(WorklistItem item, java.lang.String staffAssignmentRule, long deadline, EscalationHandling.EscalationMeasures measures, SessionToken measuresSession, PolicyResolution orgModel) Notifies that the escalation deadline or the IndividualWorklistItemSettings.getIndividualEscalationDate() has been reached for the designated (client) worklist item.
java.lang.String	getID() Gets the (unique) name of this escalation handling procedure to identify it as specified for a worklist item.

Method Detail

getID

java.lang.String getID()

Gets the (unique) name of this escalation handling procedure to identify it as specified for a worklist item.

Returns:

The (unique) name of this escalation handling procedure.

deadlineReached

void deadlineReached(WorklistItem item,
                     java.lang.String staffAssignmentRule,
                     long deadline,
                     EscalationHandling.EscalationMeasures measures,
                     SessionToken measuresSession,
                     PolicyResolution orgModel)

Notifies that the escalation deadline or the IndividualWorklistItemSettings.getIndividualEscalationDate() has been reached for the designated (client) worklist item. The EscalationMeasures allow to access the organisational model, for instance, to determine a supervisor to delegate the item to, or to update the priority and set a new deadline (due date).
The deadline is provided as absolute time (aka. a date). This allows to compare the different dates of the worklist item (escalation date, due date, individual due date) to determine which due date has been reached. In case it is the individual due date, the provided item will be a ClientWorklistItem.

Parameters:

item - The (client) worklist item for which a deadline has been reached.

staffAssignmentRule - the initial staff assignment rule of the worklist item

deadline - The deadline of the worklist item that has been reached; the deadline corresponds to the escalation date or the personal due date of the worklist item.

measures - Escalation measures that can be taken to escalate the item, for instance, increase the priority or delegate it to a supervisor.

measuresSession - The session token that must be used for accessing the given EscalationHandling.EscalationMeasures object and only for it. When e.g. other services are accessed through the registry, a new session token must be used. When de.aristaflow.adept2.core.worklistmanager.escalationmeasures.AbstractEscalationHandling is extended to implement this interface, de.aristaflow.adept2.core.worklistmanager.escalationmeasures.AbstractEscalationHandling#createSessionToken() can be used to acquire a new session.

orgModel - The policy resolution of the organisational model manager the worklist manager uses to provide access to the organisational model.