Package com.aquima.interactions.process.impl.nodes

Class NodeDefinition

java.lang.Object

com.aquima.interactions.process.impl.nodes.NodeDefinition

All Implemented Interfaces:

IProcessNodeDefinition

Direct Known Subclasses:

BranchNodeDefinition, EndNodeDefinition, JoinNodeDefinition, ProcessEndNodeDefinition, ProcessStepDefinition

public abstract class NodeDefinition
extends Object
implements IProcessNodeDefinition

Base class for all nodes in a process.

Since:

7.1

Author:

O. Kerpershoek

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NodeDefinition(GUID id)

Method Summary

Modifier and Type	Method	Description
protected void	addNextNode(String exitState, NodeDefinition node)
String[]	getExitStates()	This method returns the names of the exits that are connected to a next node.
ITimeoutDefinition	getExpirationDefinition()	This method returns information about what action should be taken in case of a timeout.
GUID	getId()	This method returns a unique ID for the node.
IProcessNodeDefinition	getNextNode()	This method returns the next node that should be processed after this node has been completed.
IProcessNodeDefinition	getNextNode(String exitState)	This method returns the next node for the specified exit state.
IProcessNodeDefinition	getNextNodeSafe(String exitState)	This method is the same as the getNextNode method, but if won't throw an exception if the next node is not available.
protected void	setExpirationDefinition(IExpression expression, ReevaluationEvent reevaluationEvent, IProcessNodeDefinition continuationPoint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aquima.interactions.process.nodes.IProcessNodeDefinition

getDisplayName

Constructor Detail

NodeDefinition

protected NodeDefinition(GUID id)

Method Detail

getId

public GUID getId()

Description copied from interface: IProcessNodeDefinition

This method returns a unique ID for the node.

Specified by:

getId in interface IProcessNodeDefinition

Returns:

a unique ID for the node.

getNextNode

public IProcessNodeDefinition getNextNode()

Description copied from interface: IProcessNodeDefinition

This method returns the next node that should be processed after this node has been completed. If there is no next node, because the process has completed, this method will return null.

Specified by:

getNextNode in interface IProcessNodeDefinition

Returns:

the next node that should be processed after this node has been completed.

getNextNode

public IProcessNodeDefinition getNextNode(String exitState)

Description copied from interface: IProcessNodeDefinition

This method returns the next node for the specified exit state. As each defined exit state should have a next node, this method will never return null, unless the default exit state (null) is provided as argument.

Specified by:

getNextNode in interface IProcessNodeDefinition

Parameters:

exitState - The exit state for which the next node is requested.

Returns:

The next node in the process.

getNextNodeSafe

public IProcessNodeDefinition getNextNodeSafe(String exitState)

This method is the same as the getNextNode method, but if won't throw an exception if the next node is not available.

Parameters:

exitState - The exit state for which the next node is requested.

Returns:

The next node for the exit state, or null is none was defined.

getExitStates

public String[] getExitStates()

This method returns the names of the exits that are connected to a next node.

Specified by:

getExitStates in interface IProcessNodeDefinition

Returns:

the names of the exits that are connected to a next node.

addNextNode

protected void addNextNode(String exitState,
                           NodeDefinition node)
                    throws InitializationException

Throws:

InitializationException

getExpirationDefinition

public ITimeoutDefinition getExpirationDefinition()

Description copied from interface: IProcessNodeDefinition

This method returns information about what action should be taken in case of a timeout. If expiration is not applicable for this node, the method will return null.

Specified by:

getExpirationDefinition in interface IProcessNodeDefinition

Returns:

information about what action should be taken in case of a timeout.

setExpirationDefinition

protected void setExpirationDefinition(IExpression expression,
                                       ReevaluationEvent reevaluationEvent,
                                       IProcessNodeDefinition continuationPoint)
                                throws InitializationException

Throws:

InitializationException