Package com.aquima.interactions.flow.model

Class FlowEngine

java.lang.Object

com.aquima.interactions.flow.model.FlowEngine

All Implemented Interfaces:

IFlowEngine

public class FlowEngine
extends Object
implements IFlowEngine

Flow engine handles the evaluation of a flow and holds all information on available flows. This object is reentrant after initialisation.

Since:

7.0

Author:

F. van der Meer, O. Kerpershoek

Constructor Summary

Constructors

Constructor	Description
FlowEngine(INodeDetailsFactory nodeFactory, IExpressionParser parser, IFlowEngineDS datasource)	Constructs a flow engine with the specified factory, parser and datasource.

Method Summary

Modifier and Type	Method	Description
IFlowState	continueFlow(IFlowState state, ExitEvent pageEvent, IFlowHandler handler)	This method will continue the flow from the point indicated by the flow state.
IFlowDetails[]	getAvailableFlows()	This method returns an array containing all the available flows from the flow engine.
IDcmWidgetFlowDefinition	getDcmWidgetFlowDefinition(String flowName)	Returns the definition of the DCM widget flow with the given name.
IExternalFlowDefinition	getExternalFlowDefinition(String flowName)	Returns the definition of the external flow with the given name.
IFlowDetails	getFlow(String flowName)	This method returns a details object for the specified flow.
IFunctionFlowDefinition	getFunctionFlowDefinition(String flowName)	This method will check if a function flow exists with the given name and return the related {IFunctionFlowDefinition}
protected InternalFlow	getInternalFlow(String name)
protected InternalNode	getInternalNode(NodeID id)
IFlowState	revertToFlow(String name, IFlowState state, IFlowHandler handler)	Revert the flow state to the flow node specified by name and start this flow.
IFlowState	startFlow(String name, IFlowHandler handler)	This method starts the flow indicated by the flow name with the specified flow handler.

Methods inherited from class java.lang.Object

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

Constructor Details

FlowEngine

public FlowEngine(INodeDetailsFactory nodeFactory,
 IExpressionParser parser,
 IFlowEngineDS datasource)
           throws InitializationException

Constructs a flow engine with the specified factory, parser and datasource.

Parameters:

nodeFactory - The node factory which will be used to create details for flow nodes.

parser - The expression parser which is used to parse expressions for condition nodes.

datasource - The data source for loading all flows.

Throws:

InitializationException - When the flow engine could not be correctly initialized.

Method Details

continueFlow

public IFlowState continueFlow(IFlowState state,
 ExitEvent pageEvent,
 IFlowHandler handler)
                        throws FlowException

Description copied from interface: IFlowEngine

This method will continue the flow from the point indicated by the flow state.

Specified by:

continueFlow in interface IFlowEngine

Parameters:

state - The previous flow state from which the flow should continue.

pageEvent - The exit state for the last result node, which determines the next action in the flow engine.

handler - The handler that should be used when processing the flow.

Returns:

Object containing the path that was followed and the result node that was reached.

Throws:

FlowException - This exception is thrown when the flow could not continue to the next result node.

startFlow

public IFlowState startFlow(String name,
 IFlowHandler handler)
                     throws FlowException

Description copied from interface: IFlowEngine

This method starts the flow indicated by the flow name with the specified flow handler.

Specified by:

startFlow in interface IFlowEngine

Parameters:

name - The name of the flow that should be started.

handler - The handler that should be used when processing the flow.

Returns:

Object containing the path that was followed and the result node that was reached.

Throws:

FlowException - This exception is thrown when the flow could not be started.

revertToFlow

public IFlowState revertToFlow(String name,
 IFlowState state,
 IFlowHandler handler)
                        throws FlowException

Description copied from interface: IFlowEngine

Revert the flow state to the flow node specified by name and start this flow. Returns null is the node is not found in the flow state. All flow nodes that are passed during revert will call the onFlowAborted method of the handler.

Specified by:

revertToFlow in interface IFlowEngine

Parameters:

name - The name of the flow that should be started.

state - The previous flow state.

handler - The handler that should be used when processing the flow.

Returns:

Object containing the path that was followed and the result node that was reached.

Throws:

FlowException - This exception is thrown when the flow could not be started from the current flow state.

getAvailableFlows

public IFlowDetails[] getAvailableFlows()

Description copied from interface: IFlowEngine

This method returns an array containing all the available flows from the flow engine.

Specified by:

getAvailableFlows in interface IFlowEngine

Returns:

an array containing all the available flows from the flow engine.

getFlow

public IFlowDetails getFlow(String flowName)
                     throws UnknownFlowException

Description copied from interface: IFlowEngine

This method returns a details object for the specified flow. The name of the flow is not case sensitive.

Specified by:

getFlow in interface IFlowEngine

Parameters:

flowName - The name of the flow for which the details are requested.

Returns:

The flow details for the specified flow name.

Throws:

UnknownFlowException - This exception is thrown when no flow with the specified name could be found.

getFunctionFlowDefinition

public IFunctionFlowDefinition getFunctionFlowDefinition(String flowName)
                                                  throws UnknownFlowException,
InvalidFunctionFlowException

Description copied from interface: IFlowEngine

This method will check if a function flow exists with the given name and return the related {IFunctionFlowDefinition}

Specified by:

getFunctionFlowDefinition in interface IFlowEngine

Parameters:

flowName - The name of the flow

Returns:

Object containing the function flow definition

Throws:

UnknownFlowException - This exception is thrown when the flow does not exist

InvalidFunctionFlowException - This exception is thrown when the flow does exist, but is not a function flow

getExternalFlowDefinition

public IExternalFlowDefinition getExternalFlowDefinition(String flowName)
                                                  throws UnknownFlowException,
InvalidExternalFlowException

Description copied from interface: IFlowEngine

Returns the definition of the external flow with the given name.

Specified by:

getExternalFlowDefinition in interface IFlowEngine

Parameters:

flowName - the name of the external flow

Returns:

the definition of the external flow

Throws:

UnknownFlowException - if no flow with the given name exists

InvalidExternalFlowException - if the flow with the given name is not an external flow

getDcmWidgetFlowDefinition

public IDcmWidgetFlowDefinition getDcmWidgetFlowDefinition(String flowName)
                                                    throws UnknownFlowException,
InvalidDcmWidgetFlowException

Description copied from interface: IFlowEngine

Returns the definition of the DCM widget flow with the given name.

Specified by:

getDcmWidgetFlowDefinition in interface IFlowEngine

Parameters:

flowName - the name of the DCM widget flow

Returns:

the definition of the DCM widget flow

Throws:

UnknownFlowException - if no flow with the given name exists

InvalidDcmWidgetFlowException - if the flow with the given name is not a DCM widget flow

getInternalFlow

protected InternalFlow getInternalFlow(String name)
                                throws UnknownFlowException

Throws:

UnknownFlowException

getInternalNode

protected InternalNode getInternalNode(NodeID id)
                                throws UnknownFlowException

Throws:

UnknownFlowException