de.aristaflow.adept2.core.worklistmanager

Interface WorklistNotification

public interface WorklistNotification

This interface provides the notification of a worklist manager in case of state changes in the execution manager. It allows to add, update and remove single activities, as well as remove all activities. Activities are represented to clients as worklist items.
Adding an activity needs an additional staff assignment rule which specifies the users that are able to perform the corresponding activity. The rule is resolved by the organisational model manager. It may not contain any dependencies, for instance, referencing the user that has performed a precedent activity. Such dependencies need to be resolved by the execution manager. Together with WorklistInteraction this interface realises the communication between execution manager and worklist manager.

All methods should be executed asynchronously that the caller returns immediately.

Author:

Ulrich Kreher

See Also:

WorklistInteraction, WorklistItem

Method Summary

Modifier and Type	Method and Description
void	addActivity(ExecutableBusinessProcessInstance ebpInstance, ProcessConstants.NodeState state, boolean suppressed, EBPInstanceReference ebpInstanceReference, java.lang.String staffAssignmentRule, boolean initialUpdate) Adds the activity, which is part of the designated node, to the worklists for the user specified by the designated staff assignment rule.
void	addAndAssignActivity(ExecutableBusinessProcessInstance ebpInstance, ProcessConstants.NodeState state, boolean suppressed, EBPInstanceReference ebpInstanceReference, java.lang.String staffAssignmentRule, QualifiedAgent agent, boolean initialUpdate) Adds and assigns the activity, which is part of the designated given node, to the worklist of the designated agent.
void	assignAndUpdateActivity(EBPInstanceReference activity, ProcessConstants.NodeState state, QualifiedAgent agent) Assign and updates the designated activity.
void	enquireActivity(EBPInstanceReference activity, Enquiry enquiry, boolean initialUpdate) Sets the designated activity in enquiry-mode, that is, the corresponding worklist item is offered to the recipients of the designated enquiry and the corresponding comment is provided appropriately in the worklist items.
void	initialUpdateComplete() Signals the worklist manager, that all necessary updates for this newly added worklist manager have been sent.
void	initialUpdateFailed() Signals the worklist manager, that the initial update has failed.
void	promoteActivity(EBPInstanceReference activity, ProcessConstants.NodeState state, java.lang.String staffAssignmentRule, QualifiedAgent agent) Promotes the designated (suppressed) activity, that is, the activity is added again to the previous worklists restoring the previous state.
void	removeActivity(EBPInstanceReference activity) Removes the designated activity from all worklists.
void	removeAllActivities() Removes all activities from all worklists, for instance, to reset a worklist manager.
void	replyEnquiry(EBPInstanceReference activity, Enquiry enquiry, boolean initialUpdate) Unsets the current enquiry-mode from the designated activity, that is, the originator of the enquiry is offered the corresponding worklist item again together with the reply, encapsulated in the designated enquiry.
void	suppressActivity(EBPInstanceReference activity, boolean initialUpdate) Suppresses the designated activity, that is, the activity is removed from all worklists but is kept within the worklist manager.
void	updateActivityState(EBPInstanceReference activity, ProcessConstants.NodeState state) Updates the state of the designated activity.

Method Detail

addActivity

void addActivity(ExecutableBusinessProcessInstance ebpInstance,
                 ProcessConstants.NodeState state,
                 boolean suppressed,
                 EBPInstanceReference ebpInstanceReference,
                 java.lang.String staffAssignmentRule,
                 boolean initialUpdate)

Adds the activity, which is part of the designated node, to the worklists for the user specified by the designated staff assignment rule. The staff assignment rule may not contain any dependencies to the corresponding process instance; these have to be resolved in advance.
If the staff assignment rule can not be resolved due to an invalid rule (the organisational model manager throws an PolicyResolutionException), it will be logged the corresponding worklist item will be assigned escalated. If the organisational model manager throws a DataSourceException, it will be logged and the resolution will be retried.

The execution of this method should be done asynchronously so that the caller returns immediately.

Parameters:

ebpInstance - An instance of the assigned activity Node.getExecutableBusinessProcess(), required to create a worklist item and to read the distribution and escalation configuration. Node.getExecutableBusinessProcess(), required to create a worklist item and to read the distribution and escalation configuration.

state - The state of the node that represents the activity to add.

suppressed - Whether the activity is currently suppressed and should therefore not be displayed in the worklists.

ebpInstanceReference - The activity to add, unambiguously identified by the corresponding tuple.

staffAssignmentRule - The rule to specify the users who are able/allowed to perform the designated activity. It may not contain any dependencies to the corresponding process instance.

initialUpdate - Whether the activity is added while initially updating the worklist manager.

Throws:

java.lang.IllegalArgumentException - If the ExecutableBusinessProcessInstance is null.

addAndAssignActivity

void addAndAssignActivity(ExecutableBusinessProcessInstance ebpInstance,
                          ProcessConstants.NodeState state,
                          boolean suppressed,
                          EBPInstanceReference ebpInstanceReference,
                          java.lang.String staffAssignmentRule,
                          QualifiedAgent agent,
                          boolean initialUpdate)

Adds and assigns the activity, which is part of the designated given node, to the worklist of the designated agent. The additional staff assignment rule is only for reassignment (in case the designated agent deselects or revokes the item) and may not contain any dependencies to the corresponding process instance; these have to be resolved in advance.
If the staff assignment rule can not be resolved due to an invalid rule (the organisational model manager throws an PolicyResolutionException), it will be logged the corresponding worklist item will be assigned escalated. If the organisational model manager throws a DataSourceException, it will be logged and the resolution will be retried.

The execution of this method should be done asynchronously so that the caller returns immediately.

This method is used, for instance, for an assigned activity when the worklist manager gets all active activities due to its registration. Since the assignment may be caused by a selection, the assignment may also be reverted (by deselecting the corresponding item). This is signalled via #updateActivityState(EBPInstanceReference, NodeState) with no staff assignment rule provided. In this case the worklist manager uses the staff assignment rule formerly provided by this method.

Parameters:

ebpInstance - An instance of the assigned activity Node.getExecutableBusinessProcess(), required to create a worklist item and to read the distribution and escalation configuration. Node.getExecutableBusinessProcess(), required to create a worklist item and to read the distribution and escalation configuration.

state - The state of the node that represents the activity to add.

suppressed - Whether the activity is currently suppressed and should therefore not be displayed in the worklists.

ebpInstanceReference - The activity to add, unambiguously identified by the corresponding tuple.

staffAssignmentRule - The rule to specify the users who are able/allowed to perform the designated activity. It may not contain any dependencies to the corresponding process instance.

initialUpdate - Whether the activity is added and assigned while initially updating the worklist manager.

agent - The agent to whom the added activity is assigned.

Throws:

java.lang.IllegalArgumentException - If the node does not contain an Activity

removeActivity

void removeActivity(EBPInstanceReference activity)

Removes the designated activity from all worklists.

The execution of this method should be done asynchronously so that the caller returns immediately.

Parameters:

activity - The activity to remove, unambiguously identified by the corresponding tuple.

updateActivityState

void updateActivityState(EBPInstanceReference activity,
                         ProcessConstants.NodeState state)

Updates the state of the designated activity. This resets the assignment in case of resetting the activity state. Otherwise the assignment will not be changed! For instance, it does not make sense to offer an already selected activity to several users. This is the responsibility of the one using this interface. It is also not checked whether the state conforms to the possible state transitions of the underlying metamodel.

The execution of this method should be done asynchronously so that the caller returns immediately.

Parameters:

activity - The activity to update the state, unambiguously identified by the corresponding tuple.

state - The new state of the activity.

assignAndUpdateActivity

void assignAndUpdateActivity(EBPInstanceReference activity,
                             ProcessConstants.NodeState state,
                             QualifiedAgent agent)

Assign and updates the designated activity. It is not checked whether the state conforms to the possible state transitions of the underlying metamodel.

The execution of this method should be done asynchronously so that the caller returns immediately.

Parameters:

activity - The activity to update the state, unambiguously identified by the corresponding tuple.

state - The new state of the activity.

agent - The agent to whom the activity is assigned.

enquireActivity

void enquireActivity(EBPInstanceReference activity,
                     Enquiry enquiry,
                     boolean initialUpdate)

Sets the designated activity in enquiry-mode, that is, the corresponding worklist item is offered to the recipients of the designated enquiry and the corresponding comment is provided appropriately in the worklist items.
This method just offers the designated activity to the appropriate enquiry recipients (and resets the worklist item assignment) but does not change anything else, for instance the state of the worklist item.

Parameters:

activity - The activity which to set in enquiry mode and therefore to assign for enquiry.

enquiry - The enquiry containing the enquiry question as well as the recipients to which the activity will be offered/reassigned.

initialUpdate - Whether the activity is enquired while initially updating the worklist manager.

See Also:

InternalWorklistItem.enquireItem(Enquiry)

replyEnquiry

void replyEnquiry(EBPInstanceReference activity,
                  Enquiry enquiry,
                  boolean initialUpdate)

Unsets the current enquiry-mode from the designated activity, that is, the originator of the enquiry is offered the corresponding worklist item again together with the reply, encapsulated in the designated enquiry. This method does not change anything else, for instance the state of the worklist item.

Parameters:

activity - The activity for which to unset the enquiry mode and therefore to send back to the originator of the designated enquiry.

enquiry - The enquiry-object containing the corresponding originator who will receive the reply as well as the reply.

initialUpdate - Whether the activity is replied while initially updating the worklist manager.

suppressActivity

void suppressActivity(EBPInstanceReference activity,
                      boolean initialUpdate)

Suppresses the designated activity, that is, the activity is removed from all worklists but is kept within the worklist manager. So all delegation and escalations are kept. The activity has to be either promoted or removed eventually. Until then it will remain within the worklist manager.

Parameters:

activity - The activity which to suppress for some time.

initialUpdate - Whether the activity is suppressed within the initial worklist update.

promoteActivity

void promoteActivity(EBPInstanceReference activity,
                     ProcessConstants.NodeState state,
                     java.lang.String staffAssignmentRule,
                     QualifiedAgent agent)

Promotes the designated (suppressed) activity, that is, the activity is added again to the previous worklists restoring the previous state. If the staff assignment rule has changed, it will be re-added and treated like a new activity. For instance, the staff-assignment rule is changed while this worklist manager is offline.

Parameters:

activity - The activity which to promote (unsuppress).

state - The current state of the activity. If this has changed while being suppressed, the worklist item state will be adapted.

staffAssignmentRule - The staff assignment rule of the designated activity. If this changed, the activity will have to be re-added instead of simply promoted.

agent - The agent to whom the activity is assigned or null if the activity is currently not assigned. If this has changed while being suppressed, the worklist item state will be adapted.

initialUpdateComplete

void initialUpdateComplete()

Signals the worklist manager, that all necessary updates for this newly added worklist manager have been sent. The worklist manager may then finish its initialisation and run normally.

The execution of this method should be done asynchronously so that the caller returns immediately.

See Also:

WorklistInteraction.addWorklistManager(de.aristaflow.adept2.base.sessionmanagement.SessionToken, WorklistNotification)

initialUpdateFailed

void initialUpdateFailed()

Signals the worklist manager, that the initial update has failed. The worklist manager should clean-up all resources and prepare for reconnecting to the execution manager by resetting the corresponding data structures.

The execution of this method should be done asynchronously so that the caller returns immediately.

See Also:

WorklistInteraction.addWorklistManager(de.aristaflow.adept2.base.sessionmanagement.SessionToken, WorklistNotification)

removeAllActivities

void removeAllActivities()

Removes all activities from all worklists, for instance, to reset a worklist manager. This method is especially useful in combination with requesting active activities (WorklistInteraction.addWorklistManager(WorklistNotification)). This will also remove suppressed activities.

The execution of this method should be done asynchronously so that the caller returns immediately.

See Also:

WorklistInteraction.addWorklistManager(de.aristaflow.adept2.base.sessionmanagement.SessionToken, WorklistNotification)