public interface FlowSession
flow definition
launched within an overall flow execution.
This object maintains all instance state including session status within exactly one governing FlowExecution, as well
as the current flow state. This object also acts as the local "flow scope" data model. Data in flow scope
lives for the life of this object and is cleaned up automatically when this object is destroyed.
Destruction happens when this session enters an end state.
Note that a flow session is in no way linked to an HTTP session. It just uses the familiar "session" naming convention to denote a stateful object.
FlowDefinition
,
FlowExecution
Modifier and Type | Method and Description |
---|---|
FlowDefinition |
getDefinition()
Returns the flow definition backing this session.
|
FlowSession |
getParent()
Returns the parent flow session in the current flow execution, or
null if there is no parent flow
session. |
MutableAttributeMap |
getScope()
Return this session's local attributes; the basis for "flow scope" (flow session scope).
|
StateDefinition |
getState()
Returns the current state of this flow session.
|
MutableAttributeMap |
getViewScope()
Returns a mutable map for data held in "view scope".
|
boolean |
isEmbeddedMode()
Returns true if the flow session was started in embedded page mode.
|
boolean |
isRoot()
Returns whether this flow session is the root flow session in the ongoing flow execution.
|
FlowDefinition getDefinition()
StateDefinition getState()
MutableAttributeMap getScope()
MutableAttributeMap getViewScope() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if this flow session is not currently in a view stateboolean isEmbeddedMode()
FlowSession getParent()
null
if there is no parent flow
session.boolean isRoot()