de.aristaflow.adept2.core.worklistmanager

Interface EscalationHandling.EscalationMeasures

All Superinterfaces:

DelegationManager

Enclosing interface:

EscalationHandling

public static interface EscalationHandling.EscalationMeasures
extends DelegationManager

EscalationMeasures provides the means to escalate a worklist item accordingly (and prevents accessing arbitrary functions of the worklist manager). It allows to update a worklist item when new values have been set, for instance, increasing the priority, setting a new escalation and setting a new due date as well as updating proprietary data.
This interface extends the DelegationManager just for reuse purpose; semantically these interfaces do not need this relation.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
void	setDueDate(SessionToken session, WorklistItem worklistItem, long dueDate) Changes the due date of the specified worklist item for displaying to the user.
void	setEscalation(SessionToken session, WorklistItem worklistItem, long escalationDate, java.lang.String escalationHandlingProcedureID) Changes the escalation date of the specified worklist item.
void	setPriority(SessionToken session, WorklistItem worklistItem, int priority) Changes the priority of the specified worklist item.
void	updateIndividualSettings(SessionToken session, ClientWorklistItem worklistItem) Changes the individual worklist item settings of the designated client worklist item in the server.
void	updatePluginData(SessionToken session, WorklistItem worklistItem, PluginData pluginData) Changes the plugin data of the designated worklist item.
void	updateUserAttributes(SessionToken session, WorklistItem worklistItem) Changes the user attributes of the designated worklist item.

Methods inherited from interface de.aristaflow.adept2.core.worklistmanager.DelegationManager

delegateBack, delegateWorkItem, getDelegationRecipients, getDelegationRecipientsIterator

Method Detail

setPriority

void setPriority(SessionToken session,
                 WorklistItem worklistItem,
                 int priority)

Changes the priority of the specified worklist item.

Parameters:

session - The session token to be used for updating the worklist item. It is the same token as provided to EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

worklistItem - The worklist item to set the priority for. It is the same worklist item as provided in EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

priority - The new priority for the worklist item.

setEscalation

void setEscalation(SessionToken session,
                   WorklistItem worklistItem,
                   long escalationDate,
                   java.lang.String escalationHandlingProcedureID)

Changes the escalation date of the specified worklist item.

Parameters:

session - The session token to be used for updating the worklist item. It is the same token as provided to EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

worklistItem - The worklist item to set the escalation date for. It is the same worklist item as provided in EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

escalationDate - The new escalation date for the worklist item.

escalationHandlingProcedureID - The ID of the new escalation handling procedure.

setDueDate

void setDueDate(SessionToken session,
                WorklistItem worklistItem,
                long dueDate)

Changes the due date of the specified worklist item for displaying to the user. This date has no effect on the escalation.

Parameters:

session - The session token to be used for updating the worklist item.

worklistItem - The worklist item to set the due date for.

dueDate - The new due date for the worklist item.

updateUserAttributes

void updateUserAttributes(SessionToken session,
                          WorklistItem worklistItem)

Changes the user attributes of the designated worklist item. This allows to set proprietary attributes for the worklist item. The user attributes are taken from the designated item and just stored so be careful not to change unknown attributes.

Parameters:

session - The session token to be used for updating the worklist item. It is the same token as provided to EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

worklistItem - The worklist item to change the user attributes. It is the same worklist item as provided in EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

updatePluginData

void updatePluginData(SessionToken session,
                      WorklistItem worklistItem,
                      PluginData pluginData)

Changes the plugin data of the designated worklist item. This allows a plugin to change and persist its data for a worklist item.

Parameters:

session - The session token to be used for updating the worklist item. It is the same token as provided to EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

worklistItem - The worklist item to change the designated plugin data of. It is the same worklist item as provided in EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).

pluginData - The plugin data which is to be updated.

updateIndividualSettings

void updateIndividualSettings(SessionToken session,
                              ClientWorklistItem worklistItem)

Changes the individual worklist item settings of the designated client worklist item in the server. This provides a convenience method for an escalation procedure instead of calling WorklistUpdateManager.updateIndividualSettings(SessionToken, ClientWorklistItem) directly.
This method will only be able to be called if the escalation has been triggered due to a personal due date.

Parameters:

session - The session token identifying the user updating the client worklist item and the session for the update process.

worklistItem - The worklist item that has been changed and of which the changes are to be propagated. It is the same (client) worklist item as provided in EscalationHandling.deadlineReached(WorklistItem, String, long, de.aristaflow.adept2.core.worklistmanager.EscalationHandling.EscalationMeasures, SessionToken, PolicyResolution).