Package com.aquima.interactions.portal.model.flow

Class PageNode

java.lang.Object

com.aquima.interactions.portal.model.flow.NodeBase

com.aquima.interactions.portal.model.flow.PageNode

All Implemented Interfaces:

INodeDetails, IResultNodeDetails, INodeDetailsWithDebugIdentifier, Serializable

public class PageNode
extends NodeBase
implements IResultNodeDetails, INodeDetailsWithDebugIdentifier

Node class for the flow engine to represent a page.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	PageNode(NodeID id, String pageName, ExitEvent[] exitEvents, Map<String,String> properties)	Constructs a page node with the specified ID, name and exit events.
protected	PageNode(NodeID id, String pageName, String[] exitEvents, Map<String,String> properties)

Method Summary

Modifier and Type	Method	Description
String	getDebugIdentifier()
ExitEvent[]	getExitStates()	This method returns an array with the possible exit states of the result (page).
String	getProperty(String key)
String[]	getPropertyKeys()
String	getResultId()	This method returns the ID of the result node.
String	toString()

Methods inherited from class com.aquima.interactions.portal.model.flow.NodeBase

getNodeId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.flow.INodeDetails

getNodeId

Constructor Details

PageNode

public PageNode(NodeID id,
 String pageName,
 ExitEvent[] exitEvents,
 Map<String,String> properties)

Constructs a page node with the specified ID, name and exit events. This constructor is used when restoring a session from XML.

Parameters:

id - The ID of the node.

pageName - The name of the page.

exitEvents - The exit events for the page node.

PageNode

protected PageNode(NodeID id,
 String pageName,
 String[] exitEvents,
 Map<String,String> properties)

Method Details

getResultId

public String getResultId()

Description copied from interface: IResultNodeDetails

This method returns the ID of the result node. This node type usually represents a page. The flow will stop when a flow node of this type is encountered.

Specified by:

getResultId in interface IResultNodeDetails

Returns:

the ID of the result node.

getExitStates

public ExitEvent[] getExitStates()

Description copied from interface: IResultNodeDetails

This method returns an array with the possible exit states of the result (page). Each exit state will be mapped to an edge in the calling flow to determine the next node.

Specified by:

getExitStates in interface IResultNodeDetails

Returns:

an array with the possible exit states of the action.

getPropertyKeys

public String[] getPropertyKeys()

getProperty

public String getProperty(String key)

getDebugIdentifier

public String getDebugIdentifier()

Specified by:

getDebugIdentifier in interface INodeDetailsWithDebugIdentifier

toString

public String toString()

Overrides:

toString in class Object