ee.telekom.workflow.graph

Interface GraphEngine

All Superinterfaces:

GraphEngineFacade

All Known Implementing Classes:

GraphEngineImpl

public interface GraphEngine
extends GraphEngineFacade

A GraphEngine is the interface that is internally used used to communicated with a graph engine.

Method Summary

Modifier and Type	Method and Description
GraphWorkItem	addHumanTaskItem(GraphInstance instance, Token token, String role, String user, Map<String,Object> arguments) Adds a new HumanTaskItem to the given instance which is associated to the given token.
GraphWorkItem	addSignalItem(GraphInstance instance, Token token, String signal) Adds a new SignalItem to the given instance which is associated to the given token.
GraphWorkItem	addTaskItem(GraphInstance instance, Token token, String bean, String method, Object[] arguments) Adds a new TaskItem to the given instance which is associated to the given token.
GraphWorkItem	addTimerItem(GraphInstance instance, Token token, Date dueDate) Adds a new TimerItem to the given instance which is associated to the given token.
Token	addToken(GraphInstance instance, Node node, Token parent) Adds a new, active token to the given instance pointing to the given node with the given parent.
void	cancel(Token token) Cancels the given token.
void	cancelWorkItem(Token token) If existent, cancels the active work item associated with the given token.
void	complete(Token token, Object result) A shorthand for complete(Token, Object, String) using a the default transition name Transition.DEFAULT_TRANSITION_NAME.
void	complete(Token token, Object result, String transitionName) Finishes the execution of the given Token's current Node on the associated GraphInstance.
void	terminate(Token token) Marks the given token and all direct parent tokens active that do not have any further active child tokens.

Methods inherited from interface ee.telekom.workflow.graph.GraphEngineFacade

abort, complete, getBeanResolver, getNewGraphInstanceCreator, getRepository, registerInstanceEventListener, registerNodeEventListener, registerWorkItemEventListener, start, start, start, start, start, start, start

Method Detail

addToken

Token addToken(GraphInstance instance,
               Node node,
               Token parent)

Adds a new, active token to the given instance pointing to the given node with the given parent.

Parameters:

instance - the instance to add to

node - the node that the new token will point to

parent - the new token's parent token

Returns:

the new token

addSignalItem

GraphWorkItem addSignalItem(GraphInstance instance,
                            Token token,
                            String signal)

Adds a new SignalItem to the given instance which is associated to the given token. The SignalItem is awaiting a signal with the given name.

Parameters:

instance - the instance to add the new signal item to

token - the token to associate the signal item with

signal - the signal's name to wait for

Returns:

the new signal item

addTimerItem

GraphWorkItem addTimerItem(GraphInstance instance,
                           Token token,
                           Date dueDate)

Adds a new TimerItem to the given instance which is associated to the given token. The TimerItem is awaiting the given dueDate.

Parameters:

instance - the instance to add the new timer item to

token - the token to associate the timer item with

dueDate - the due date to wait for

Returns:

the new timer item

addTaskItem

GraphWorkItem addTaskItem(GraphInstance instance,
                          Token token,
                          String bean,
                          String method,
                          Object[] arguments)

Adds a new TaskItem to the given instance which is associated to the given token. The TaskItem is awaiting external execution.

Parameters:

instance - the instance to add the new task item to

token - the token to associate the task item with

bean - the bean to call a method on

method - the method to call to

arguments - the method call's arguments

Returns:

the new task item

addHumanTaskItem

GraphWorkItem addHumanTaskItem(GraphInstance instance,
                               Token token,
                               String role,
                               String user,
                               Map<String,Object> arguments)

Adds a new HumanTaskItem to the given instance which is associated to the given token. The HumanTaskItem is awaiting external resolution.

Parameters:

instance - the instance to add the new human task item to

token - the token to associate the human task item with

role - the role a user must be assigned to resolve the given task

user - the user the task is assigned to or null if the assignment is role based.

arguments - the task arguments

Returns:

the new human task item

cancelWorkItem

void cancelWorkItem(Token token)

If existent, cancels the active work item associated with the given token.

complete

void complete(Token token,
              Object result)

A shorthand for complete(Token, Object, String) using a the default transition name Transition.DEFAULT_TRANSITION_NAME.

complete

void complete(Token token,
              Object result,
              String transitionName)

Finishes the execution of the given Token's current Node on the associated GraphInstance. The method will take the required steps to merge the given result into the graph instance's Environment and to continue the token's execution along the Transition with the given name.

If a call to Node.execute(GraphEngine, Token) does not contain a call to this method, then the token's execution halts at that point. This is generally referred to as a wait state. This occurs, for example, if the action represented by that node must be done by a human or some external system.
When the external system has determined that the Node has completed its work, it should invoke GraphEngineFacade#complete(WorkItem) to continue executing the graph instance.

Parameters:

token - The token to continue execution on

result - The result of the node execution

transitionName - The transition's name along which to continue execution

cancel

void cancel(Token token)

Cancels the given token. I.e. marks the token as inactive an call's the Node.cancel(GraphEngine, Token) on the node that this token is currently pointing to.

terminate

void terminate(Token token)

Marks the given token and all direct parent tokens active that do not have any further active child tokens.