Class Flow
- java.lang.Object
-
- javax.faces.flow.Flow
-
public abstract class Flow extends java.lang.Object
Flow is the runtime representation of a Faces Flow. Once placed into service by the runtime, an instance of this class is immutable. The implementation must be thread-safe because instances will be shared across all usages of the flow within the application.
- Since:
- 2.2
-
-
Constructor Summary
Constructors Constructor Description Flow()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.lang.String
getClientWindowFlowId(ClientWindow curWindow)
Obtain the currentClientWindow
from theExternalContext
.abstract java.lang.String
getDefiningDocumentId()
Return the immutable application unique identifier for the document in which the argument flow is defined.abstract MethodExpression
getFinalizer()
Return theMethodExpression
that must be called by the runtime as the last thing that happens before exiting this flow.abstract FlowCallNode
getFlowCall(Flow targetFlow)
Return theFlowCallNode
that represents calling thetargetFlow
from this flow, ornull
iftargetFlow
cannot be reached from this flow.abstract java.util.Map<java.lang.String,FlowCallNode>
getFlowCalls()
Return an immutable data structure containing all the flow call nodes declared for this flow.abstract java.lang.String
getId()
Return the immutable id for this Flow.abstract java.util.Map<java.lang.String,Parameter>
getInboundParameters()
Return an immutable data structure containing the inbound parameters that have been declared for this flow.abstract MethodExpression
getInitializer()
Return theMethodExpression
that must be called by the runtime immediately after activating anyFlowScoped
beans declared for this flow.abstract java.util.List<MethodCallNode>
getMethodCalls()
Return an immutable data structure containing all the method call nodes declared for this flow.abstract java.util.Map<java.lang.String,java.util.Set<NavigationCase>>
getNavigationCases()
abstract FlowNode
getNode(java.lang.String nodeId)
abstract java.util.Map<java.lang.String,ReturnNode>
getReturns()
Return an immutable data structure containing all of the return nodes declared for this flow.abstract java.lang.String
getStartNodeId()
Return the immutable id for the default node that should be activated when this flow is entered.abstract java.util.Map<java.lang.String,SwitchNode>
getSwitches()
Return an immutable data structure containing all of the switch nodes declared for this flow.abstract java.util.List<ViewNode>
getViews()
Return an immutable data structure containing all of the view nodes declared for this flow.
-
-
-
Method Detail
-
getId
public abstract java.lang.String getId()
Return the immutable id for this Flow. This must be unique within the defining document (such as an Application Configuration Resources file), but need not be unique within the entire application.
- Since:
- 2.2
-
getDefiningDocumentId
public abstract java.lang.String getDefiningDocumentId()
Return the immutable application unique identifier for the document in which the argument flow is defined.
- Since:
- 2.2
-
getStartNodeId
public abstract java.lang.String getStartNodeId()
Return the immutable id for the default node that should be activated when this flow is entered.
- Since:
- 2.2
-
getFinalizer
public abstract MethodExpression getFinalizer()
Return the
MethodExpression
that must be called by the runtime as the last thing that happens before exiting this flow. AnyFlowScoped
beans declared for this flow must remain in scope until after control returns from the method referenced by thisMethodExpression
.- Since:
- 2.2
-
getInitializer
public abstract MethodExpression getInitializer()
Return the
MethodExpression
that must be called by the runtime immediately after activating anyFlowScoped
beans declared for this flow.- Since:
- 2.2
-
getInboundParameters
public abstract java.util.Map<java.lang.String,Parameter> getInboundParameters()
Return an immutable data structure containing the inbound parameters that have been declared for this flow. See
FlowHandler.transition(javax.faces.context.FacesContext, javax.faces.flow.Flow, javax.faces.flow.Flow, javax.faces.flow.FlowCallNode, java.lang.String)
for the specification of how these parameters are used. Inbound parameters are associated with a specific flow instance, while outbound parameters are associated with aFlowCallNode
that causes the transition to a new flow.- Since:
- 2.2
-
getViews
public abstract java.util.List<ViewNode> getViews()
Return an immutable data structure containing all of the view nodes declared for this flow.
- Since:
- 2.2
-
getReturns
public abstract java.util.Map<java.lang.String,ReturnNode> getReturns()
Return an immutable data structure containing all of the return nodes declared for this flow.
- Since:
- 2.2
-
getSwitches
public abstract java.util.Map<java.lang.String,SwitchNode> getSwitches()
Return an immutable data structure containing all of the switch nodes declared for this flow.
- Since:
- 2.2
-
getFlowCalls
public abstract java.util.Map<java.lang.String,FlowCallNode> getFlowCalls()
Return an immutable data structure containing all the flow call nodes declared for this flow.
- Since:
- 2.2
-
getFlowCall
public abstract FlowCallNode getFlowCall(Flow targetFlow)
Return the
FlowCallNode
that represents calling thetargetFlow
from this flow, ornull
iftargetFlow
cannot be reached from this flow.- Since:
- 2.2
-
getMethodCalls
public abstract java.util.List<MethodCallNode> getMethodCalls()
Return an immutable data structure containing all the method call nodes declared for this flow.
- Since:
- 2.2
-
getNode
public abstract FlowNode getNode(java.lang.String nodeId)
-
getNavigationCases
public abstract java.util.Map<java.lang.String,java.util.Set<NavigationCase>> getNavigationCases()
-
getClientWindowFlowId
public abstract java.lang.String getClientWindowFlowId(ClientWindow curWindow)
Obtain the current
ClientWindow
from theExternalContext
. Get the window's id and append "_" and the return fromgetId()
. Return the result.- Since:
- 2.2
-
-