org.springframework.webflow.engine.model

Class FlowModel

java.lang.Object

org.springframework.webflow.engine.model.AbstractModel

org.springframework.webflow.engine.model.FlowModel

All Implemented Interfaces:

Model

public class FlowModel
extends AbstractModel

Model support for flows.

Defines exactly one flow definition. A flow is composed of one or more states that define the steps of a conversation. One of those steps is the start state, which defines the conversation's starting point.
A flow may also exhibit the following characteristics:

• Be annotated with attributes that define descriptive properties that may affect flow execution. (See AttributeModel)
• Be secured (See SecuredModel)
• Be a persistence context for managing persistent objects during the course of flow execution. (See PersistenceContextModel)
• Instantiate a set of instance variables when started. (See VarModel)
• Map input provided by callers that start it (See InputModel)
• Return output to callers that end it. (See OutputModel)
• Execute actions at start time and end time. (See EvaluateModel, RenderModel and SetModel)
• Define transitions shared by all states. (See TransitionModel)
• Handle exceptions thrown by during flow execution. (See ExceptionHandlerModel)
• Import one or more local bean definition files defining custom flow artifacts (such as actions, exception handlers, view factories, transition criteria, etc). (See BeanImportModel)

Author:

Scott Andrews

Constructor Summary

Constructors

Constructor and Description
FlowModel() Create a flow model

Method Summary

Methods

Modifier and Type	Method and Description
Model	createCopy() Create a deep copy of this model.
java.lang.String	getAbstract()
java.util.LinkedList<AttributeModel>	getAttributes()
java.util.LinkedList<BeanImportModel>	getBeanImports()
java.util.LinkedList<ExceptionHandlerModel>	getExceptionHandlers()
java.util.LinkedList<TransitionModel>	getGlobalTransitions()
java.util.LinkedList<InputModel>	getInputs()
java.util.LinkedList<AbstractActionModel>	getOnEndActions()
java.util.LinkedList<AbstractActionModel>	getOnStartActions()
java.util.LinkedList<OutputModel>	getOutputs()
java.lang.String	getParent()
PersistenceContextModel	getPersistenceContext()
SecuredModel	getSecured()
java.lang.String	getStartStateId()
AbstractStateModel	getStateById(java.lang.String id) Get the state model for an identifier
java.util.LinkedList<AbstractStateModel>	getStates()
java.util.LinkedList<VarModel>	getVars()
boolean	isMergeableWith(Model model) Determine if the model is able to be merged into the current model
void	merge(Model model) Merge the model into the current model
void	setAbstract(java.lang.String abztract)
void	setAttributes(java.util.LinkedList<AttributeModel> attributes)
void	setBeanImports(java.util.LinkedList<BeanImportModel> beanImports)
void	setExceptionHandlers(java.util.LinkedList<ExceptionHandlerModel> exceptionHandlers)
void	setGlobalTransitions(java.util.LinkedList<TransitionModel> globalTransitions)
void	setInputs(java.util.LinkedList<InputModel> inputs)
void	setOnEndActions(java.util.LinkedList<AbstractActionModel> onEndActions)
void	setOnStartActions(java.util.LinkedList<AbstractActionModel> onStartActions)
void	setOutputs(java.util.LinkedList<OutputModel> outputs)
void	setParent(java.lang.String parent)
void	setPersistenceContext(PersistenceContextModel persistenceContext)
void	setSecured(SecuredModel secured)
void	setStartStateId(java.lang.String startStateId)
void	setStates(java.util.LinkedList<AbstractStateModel> states)
void	setVars(java.util.LinkedList<VarModel> vars)

Methods inherited from class org.springframework.webflow.engine.model.AbstractModel

copy, copyList, merge, merge, merge, merge, merge

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModel

public FlowModel()

Create a flow model

Method Detail

isMergeableWith

public boolean isMergeableWith(Model model)

Description copied from interface: Model

Determine if the model is able to be merged into the current model

Parameters:

model - the model to compare

Returns:

true if able to merge

merge

public void merge(Model model)

Description copied from interface: Model

Merge the model into the current model

Parameters:

model - the model to merge with

createCopy

public Model createCopy()

Description copied from interface: Model

Create a deep copy of this model. Needed when merging models and collections.

Returns:

a deep copy of this model

getAbstract

public java.lang.String getAbstract()

Returns:

the abstract

setAbstract

public void setAbstract(java.lang.String abztract)

Parameters:

abztract - the abstract to set

getParent

public java.lang.String getParent()

Returns:

the parent

setParent

public void setParent(java.lang.String parent)

Parameters:

parent - the parent to set

getStartStateId

public java.lang.String getStartStateId()

Returns:

the id of the flow's start state

setStartStateId

public void setStartStateId(java.lang.String startStateId)

Parameters:

startStateId - the id of the flow's start state to set

getAttributes

public java.util.LinkedList<AttributeModel> getAttributes()

Returns:

the attributes

setAttributes

public void setAttributes(java.util.LinkedList<AttributeModel> attributes)

Parameters:

attributes - the attributes to set

getSecured

public SecuredModel getSecured()

Returns:

the secured

setSecured

public void setSecured(SecuredModel secured)

Parameters:

secured - the secured to set

getPersistenceContext

public PersistenceContextModel getPersistenceContext()

Returns:

the persistence context

setPersistenceContext

public void setPersistenceContext(PersistenceContextModel persistenceContext)

Parameters:

persistenceContext - the persistence context to set

getVars

public java.util.LinkedList<VarModel> getVars()

Returns:

the vars

setVars

public void setVars(java.util.LinkedList<VarModel> vars)

Parameters:

vars - the vars to set

getInputs

public java.util.LinkedList<InputModel> getInputs()

Returns:

the input mappings

setInputs

public void setInputs(java.util.LinkedList<InputModel> inputs)

Parameters:

inputs - the input mappings to set

getOutputs

public java.util.LinkedList<OutputModel> getOutputs()

Returns:

the output mappings

setOutputs

public void setOutputs(java.util.LinkedList<OutputModel> outputs)

Parameters:

outputs - the output mappings to set

getOnStartActions

public java.util.LinkedList<AbstractActionModel> getOnStartActions()

Returns:

the on start actions

setOnStartActions

public void setOnStartActions(java.util.LinkedList<AbstractActionModel> onStartActions)

Parameters:

onStartActions - the on start actions to set

getStates

public java.util.LinkedList<AbstractStateModel> getStates()

Returns:

the states

getStateById

public AbstractStateModel getStateById(java.lang.String id)

Get the state model for an identifier

Parameters:

id - the state identifier to find

Returns:

the state or null if the identifier was not found

setStates

public void setStates(java.util.LinkedList<AbstractStateModel> states)

Parameters:

states - the states to set

getGlobalTransitions

public java.util.LinkedList<TransitionModel> getGlobalTransitions()

Returns:

the global transitions

setGlobalTransitions

public void setGlobalTransitions(java.util.LinkedList<TransitionModel> globalTransitions)

Parameters:

globalTransitions - the global transitions to set

getOnEndActions

public java.util.LinkedList<AbstractActionModel> getOnEndActions()

Returns:

the on end actions

setOnEndActions

public void setOnEndActions(java.util.LinkedList<AbstractActionModel> onEndActions)

Parameters:

onEndActions - the on end actions to set

getExceptionHandlers

public java.util.LinkedList<ExceptionHandlerModel> getExceptionHandlers()

Returns:

the exception handlers

setExceptionHandlers

public void setExceptionHandlers(java.util.LinkedList<ExceptionHandlerModel> exceptionHandlers)

Parameters:

exceptionHandlers - the exception handlers to set

getBeanImports

public java.util.LinkedList<BeanImportModel> getBeanImports()

Returns:

the bean imports

setBeanImports

public void setBeanImports(java.util.LinkedList<BeanImportModel> beanImports)

Parameters:

beanImports - the bean imports to set