de.aristaflow.adept2.core.executionmanager

Interface WorklistInteraction

public interface WorklistInteraction

This interface is for the communication of worklist managers with an execution manager. It allows for registering and deregistering of worklist managers. Together with WorklistNotification this interface realises the communication between execution manager and worklist manager.

Author:

Ulrich Kreher

See Also:

WorklistNotification

Method Summary

Modifier and Type	Method and Description
void	addWorklistManager(SessionToken session, WorklistNotification worklistManager) Adds a worklist manager to this execution manager to listen for state changes.
void	removeWorklistManager(SessionToken session, WorklistNotification worklistManager) Removes a listening worklist manager from this execution manager.

Method Detail

addWorklistManager

void addWorklistManager(SessionToken session,
                        WorklistNotification worklistManager)

Adds a worklist manager to this execution manager to listen for state changes. The worklist manager is notified when state changes occur, for instance, a process step may be executed, is executed or has finished execution.

Before any actual state changes are sent, the worklist manager will receive all active activities asynchronously via the WorklistNotification interface. This means the method will not block until the activities are delivered. As soon as removeWorklistManager(SessionToken, WorklistNotification) is called with the same WorklistNotification-instance, the delivering of active activities is cancelled and no further active activities will be sent.

Parameters:

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

worklistManager - An object that wants to listen to state changes of the managed instances.

removeWorklistManager

void removeWorklistManager(SessionToken session,
                           WorklistNotification worklistManager)

Removes a listening worklist manager from this execution manager. Pending updates may still occur. If the worklist manager has not been registered before, the removal will be ignored.

Parameters:

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

worklistManager - An object that does not want to listen to state changes of the managed instances.