Package org.chenile.stm.model

Class FlowDescriptor

java.lang.Object

org.chenile.stm.model.FlowDescriptor

All Implemented Interfaces:

TransientActionsAwareDescriptor

public class FlowDescriptor
extends Object
implements TransientActionsAwareDescriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowDescriptor.EventI

Field Summary

Fields

Modifier and Type	Field	Description
private STMAction<?>	entryAction
private STMAction<?>	exitAction
private STMFlowStoreImpl	flowStore
private String	id
private String	initialState
private boolean	isDefault
private StateEntityRetrievalStrategy<? extends StateEntity>	retrievalStrategy
private boolean	skipEntryExitActionsForAutoStates
private Map<String,StateDescriptor>	states
private STMSecurityStrategy	stmSecurityStrategy

Constructor Summary

Constructors

Constructor	Description
FlowDescriptor()

Method Summary

Modifier and Type	Method	Description
void	addsd(StateDescriptor sd)
FlowDescriptor	addState(StateDescriptor sd)
AutomaticStateDescriptor	autoState(String id)
AutomaticStateDescriptor	autoState(String id, boolean initialState)
FlowDescriptor	entryAction(STMAction<?> entryAction)
FlowDescriptor	exitAction(STMAction<?> exitAction)
STMAction<?>	getEntryAction()
STMAction<?>	getExitAction()
STMFlowStoreImpl	getFlowStore()
String	getId()
String	getInitialState()
StateEntityRetrievalStrategy<? extends StateEntity>	getRetrievalStrategy()
Map<String,StateDescriptor>	getStates()
List<Map<String,Object>>	getStatesInfo()
STMSecurityStrategy	getStmSecurityStrategy()
FlowDescriptor	id(String id)
FlowDescriptor	initialState(String initialState)
boolean	isDefault()
boolean	isSkipEntryExitActionsForAutoStates()
FlowDescriptor	makeDefault()
ManualStateDescriptor	manualState(String id)
ManualStateDescriptor	manualState(String id, boolean initialState)
private Collection<StateDescriptor>	obtainDynamicStates(EnablementStrategy enablementStrategy)
FlowDescriptor	retrievalStrategy(StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy)
FlowDescriptor	securityStrategy(STMSecurityStrategy stmSecurityStrategy)
void	setDefault(boolean isDefault)
void	setEntryAction(STMAction<?> entryAction)
void	setExitAction(STMAction<?> exitAction)
void	setFlowStore(STMFlowStoreImpl flowStore)
void	setId(String id)
void	setInitialState(String initialState)
void	setInitialState(StateDescriptor stateDescriptor)
void	setRetrievalStrategy(StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy)
void	setSkipEntryExitActionsForAutoStates(boolean skipEntryExitActionsForAutoStates)
void	setStates(Map<String,StateDescriptor> states)
void	setStmSecurityStrategy(STMSecurityStrategy stmSecurityStrategy)
FlowDescriptor	skipEntryExitActionsForAutoStates(boolean skipEntryExitActionsForAutoStates)
String	toJson()
Map<String,Object>	toMap()
String	toString()
String	toXml()
void	validate(STMFlowStore flowStore)

Methods inherited from class java.lang.Object

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

Field Details

id

private String id

isDefault

private boolean isDefault

states

private Map<String,StateDescriptor> states

initialState

private String initialState

entryAction

private STMAction<?> entryAction

skipEntryExitActionsForAutoStates

private boolean skipEntryExitActionsForAutoStates

stmSecurityStrategy

private STMSecurityStrategy stmSecurityStrategy

exitAction

private STMAction<?> exitAction

retrievalStrategy

private StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy

flowStore

private STMFlowStoreImpl flowStore

Constructor Details

FlowDescriptor

public FlowDescriptor()

Method Details

isSkipEntryExitActionsForAutoStates

public boolean isSkipEntryExitActionsForAutoStates()

setSkipEntryExitActionsForAutoStates

public void setSkipEntryExitActionsForAutoStates(boolean skipEntryExitActionsForAutoStates)

skipEntryExitActionsForAutoStates

public FlowDescriptor skipEntryExitActionsForAutoStates(boolean skipEntryExitActionsForAutoStates)

getEntryAction

public STMAction<?> getEntryAction()

setEntryAction

public void setEntryAction(STMAction<?> entryAction)

Specified by:

setEntryAction in interface TransientActionsAwareDescriptor

entryAction

public FlowDescriptor entryAction(STMAction<?> entryAction)

getExitAction

public STMAction<?> getExitAction()

setExitAction

public void setExitAction(STMAction<?> exitAction)

Specified by:

setExitAction in interface TransientActionsAwareDescriptor

exitAction

public FlowDescriptor exitAction(STMAction<?> exitAction)

setId

public void setId(String id)

id

public FlowDescriptor id(String id)

getId

public String getId()

setDefault

public void setDefault(boolean isDefault)

makeDefault

public FlowDescriptor makeDefault()

isDefault

public boolean isDefault()

setStates

public void setStates(Map<String,StateDescriptor> states)

getStates

public Map<String,StateDescriptor> getStates()

obtainDynamicStates

private Collection<StateDescriptor> obtainDynamicStates(EnablementStrategy enablementStrategy)

addsd

public void addsd(StateDescriptor sd)
           throws STMException

Throws:

STMException

addState

public FlowDescriptor addState(StateDescriptor sd)
                        throws STMException

Throws:

STMException

setInitialState

public void setInitialState(String initialState)

initialState

public FlowDescriptor initialState(String initialState)

getInitialState

public String getInitialState()

validate

public void validate(STMFlowStore flowStore)
              throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

toXml

public String toXml()

setRetrievalStrategy

public void setRetrievalStrategy(StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy)

retrievalStrategy

public FlowDescriptor retrievalStrategy(StateEntityRetrievalStrategy<? extends StateEntity> retrievalStrategy)

getRetrievalStrategy

public StateEntityRetrievalStrategy<? extends StateEntity> getRetrievalStrategy()

getStatesInfo

public List<Map<String,Object>> getStatesInfo()

getStmSecurityStrategy

public STMSecurityStrategy getStmSecurityStrategy()

setStmSecurityStrategy

public void setStmSecurityStrategy(STMSecurityStrategy stmSecurityStrategy)

securityStrategy

public FlowDescriptor securityStrategy(STMSecurityStrategy stmSecurityStrategy)

manualState

public ManualStateDescriptor manualState(String id)
                                  throws STMException

Throws:

STMException

manualState

public ManualStateDescriptor manualState(String id,
 boolean initialState)
                                  throws STMException

Throws:

STMException

autoState

public AutomaticStateDescriptor autoState(String id)
                                   throws STMException

Throws:

STMException

autoState

public AutomaticStateDescriptor autoState(String id,
 boolean initialState)
                                   throws STMException

Throws:

STMException

getFlowStore

public STMFlowStoreImpl getFlowStore()

setFlowStore

public void setFlowStore(STMFlowStoreImpl flowStore)

setInitialState

public void setInitialState(StateDescriptor stateDescriptor)

toJson

public String toJson()

toMap

public Map<String,Object> toMap()