EE4J 10.0.0 · jakarta.faces.flow.Flow

Access	Constructor and Description
public	Flow()

Method Summary

Modifier and Type	Method and Description
public abstract String	Returns: the generated client window id for this flow. getClientWindowFlowId(ClientWindow the curWindow) Get the `ClientWindow`'s id and append "_" and the return from `getId`.
public abstract String	Returns: the defining document id getDefiningDocumentId() Return the immutable application unique identifier for the document in which the argument flow is defined.
public abstract MethodExpression	Returns: the `MethodExpresion` for the finalizer. getFinalizer() Return the `MethodExpression` that must be called by the runtime as the last thing that happens before exiting this flow.
public abstract FlowCallNode	Returns: a `FlowCallNode` for the argument flow or `null` getFlowCall(Flow the flow for which the `FlowCallNode` is to be returned targetFlow) Return the `FlowCallNode` that represents calling the `targetFlow` from this flow, or `null` if `targetFlow` cannot be reached from this flow.
public abstract Map<String, FlowCallNode>	Returns: the flow call nodes for this flow getFlowCalls() Return an immutable data structure containing all the flow call nodes declared for this flow.
public abstract String	Returns: the id. getId() Return the immutable id for this Flow.
public abstract Map<String, Parameter>	Returns: the inbound parameters getInboundParameters() Return an immutable data structure containing the inbound parameters that have been declared for this flow.
public abstract MethodExpression	Returns: the `MethodExpresion` for the initializer. getInitializer() Return the `MethodExpression` that must be called by the runtime immediately after activating any `FlowScoped` beans declared for this flow.
public abstract List<MethodCallNode>	Returns: the method call nodes for this flow getMethodCalls() Return an immutable data structure containing all the method call nodes declared for this flow.
public abstract Map<String, Set<NavigationCase>>	Returns: the navigation cases, getNavigationCases() Return an unmodifiable view of the navigation cases within this flow.
public abstract FlowNode	Returns: the `FlowNode` or `null` getNode(String the node id for which the `FlowNode` is to be returned nodeId) Return the generic `FlowNode` by id, or `null` if not found.
public abstract Map<String, ReturnNode>	Returns: the return nodes for this flow. getReturns() Return an immutable data structure containing all of the return nodes declared for this flow.
public abstract String	Returns: the id of the start node getStartNodeId() Return the immutable id for the default node that should be activated when this flow is entered.
public abstract Map<String, SwitchNode>	Returns: the switch nodes for this flow getSwitches() Return an immutable data structure containing all of the switch nodes declared for this flow.
public abstract List<ViewNode>	Returns: the view nodes for this flow getViews() Return an immutable data structure containing all of the view nodes declared for this flow.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Flow	back to summary
public Flow()

Method Detail

getClientWindowFlowId back to summary

getClientWindowFlowId	back to summary
public abstract String getClientWindowFlowId(ClientWindow curWindow) Get the `ClientWindow`'s id and append "_" and the return from `getId`. Return the result. Parameters curWindow:ClientWindow the Returns:String the generated client window id for this flow. Since 2.2

public abstract String getClientWindowFlowId(ClientWindow curWindow)

Get the ClientWindow's id and append "_" and the return from getId. Return the result.

Parameters

curWindow:ClientWindow: the

Returns:String

the generated client window id for this flow.

Since

2.2

getDefiningDocumentId	back to summary
public abstract String getDefiningDocumentId() Return the immutable application unique identifier for the document in which the argument flow is defined. Returns:String the defining document id Since 2.2

getDefiningDocumentId

back to summary

public abstract String getDefiningDocumentId()

Return the immutable application unique identifier for the document in which the argument flow is defined.

Returns:String: the defining document id
Since: 2.2

getFinalizer back to summary

getFinalizer	back to summary
public abstract MethodExpression getFinalizer() Return the `MethodExpression` that must be called by the runtime as the last thing that happens before exiting this flow. Any `FlowScoped` beans declared for this flow must remain in scope until after control returns from the method referenced by this `MethodExpression`. Returns:MethodExpression the `MethodExpresion` for the finalizer. Since 2.2

public abstract MethodExpression getFinalizer()

Return the MethodExpression that must be called by the runtime as the last thing that happens before exiting this flow. Any FlowScoped beans declared for this flow must remain in scope until after control returns from the method referenced by this MethodExpression.

Returns:MethodExpression: the MethodExpresion for the finalizer.
Since: 2.2

getFlowCall back to summary

getFlowCall	back to summary
public abstract FlowCallNode getFlowCall(Flow targetFlow) Return the `FlowCallNode` that represents calling the `targetFlow` from this flow, or `null` if `targetFlow` cannot be reached from this flow. Parameters targetFlow:Flow the flow for which the `FlowCallNode` is to be returned Returns:FlowCallNode a `FlowCallNode` for the argument flow or `null` Since 2.2

public abstract FlowCallNode getFlowCall(Flow targetFlow)

Return the FlowCallNode that represents calling the targetFlow from this flow, or null if targetFlow cannot be reached from this flow.

Parameters

targetFlow:Flow: the flow for which the FlowCallNode is to be returned

Returns:FlowCallNode

a FlowCallNode for the argument flow or null

Since

2.2

getFlowCalls	back to summary
public abstract Map<String, FlowCallNode> getFlowCalls() Return an immutable data structure containing all the flow call nodes declared for this flow. Returns:Map<String, FlowCallNode> the flow call nodes for this flow Since 2.2

getFlowCalls

back to summary

public abstract Map<String, FlowCallNode> getFlowCalls()

Return an immutable data structure containing all the flow call nodes declared for this flow.

Returns:Map<String, FlowCallNode>: the flow call nodes for this flow
Since: 2.2

getId	back to summary
public abstract 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. Returns:String the id. Since 2.2

getId

back to summary

public abstract 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.

Returns:String: the id.
Since: 2.2

getInboundParameters back to summary

getInboundParameters	back to summary
public abstract Map<String, Parameter> getInboundParameters() Return an immutable data structure containing the inbound parameters that have been declared for this flow. See `FlowHandler#transition` for the specification of how these parameters are used. Inbound parameters are associated with a specific flow instance, while outbound parameters are associated with a `FlowCallNode` that causes the transition to a new flow. Returns:Map<String, Parameter> the inbound parameters Since 2.2

public abstract Map<String, Parameter> getInboundParameters()

Return an immutable data structure containing the inbound parameters that have been declared for this flow. See FlowHandler#transition for the specification of how these parameters are used. Inbound parameters are associated with a specific flow instance, while outbound parameters are associated with a FlowCallNode that causes the transition to a new flow.

Returns:Map<String, Parameter>: the inbound parameters
Since: 2.2

getInitializer back to summary

getInitializer	back to summary
public abstract MethodExpression getInitializer() Return the `MethodExpression` that must be called by the runtime immediately after activating any `FlowScoped` beans declared for this flow. Returns:MethodExpression the `MethodExpresion` for the initializer. Since 2.2

public abstract MethodExpression getInitializer()

Return the MethodExpression that must be called by the runtime immediately after activating any FlowScoped beans declared for this flow.

Returns:MethodExpression: the MethodExpresion for the initializer.
Since: 2.2

getMethodCalls	back to summary
public abstract List<MethodCallNode> getMethodCalls() Return an immutable data structure containing all the method call nodes declared for this flow. Returns:List<MethodCallNode> the method call nodes for this flow Since 2.2

getMethodCalls

back to summary

public abstract List<MethodCallNode> getMethodCalls()

Return an immutable data structure containing all the method call nodes declared for this flow.

Returns:List<MethodCallNode>: the method call nodes for this flow
Since: 2.2

getNavigationCases

back to summary

public abstract Map<String, Set<NavigationCase>> getNavigationCases()

Return an unmodifiable view of the navigation cases within this flow.

Returns:Map<String, Set<NavigationCase>>: the navigation cases,

getNode back to summary

getNode	back to summary
public abstract FlowNode getNode(String nodeId) Return the generic `FlowNode` by id, or `null` if not found. Parameters nodeId:String the node id for which the `FlowNode` is to be returned Returns:FlowNode the `FlowNode` or `null`

public abstract FlowNode getNode(String nodeId)

Return the generic FlowNode by id, or null if not found.

Parameters

nodeId:String: the node id for which the FlowNode is to be returned

Returns:FlowNode

the FlowNode or null

getReturns	back to summary
public abstract Map<String, ReturnNode> getReturns() Return an immutable data structure containing all of the return nodes declared for this flow. Returns:Map<String, ReturnNode> the return nodes for this flow. Since 2.2

getReturns

back to summary

public abstract Map<String, ReturnNode> getReturns()

Return an immutable data structure containing all of the return nodes declared for this flow.

Returns:Map<String, ReturnNode>: the return nodes for this flow.
Since: 2.2

getStartNodeId	back to summary
public abstract String getStartNodeId() Return the immutable id for the default node that should be activated when this flow is entered. Returns:String the id of the start node Since 2.2

getStartNodeId

back to summary

public abstract String getStartNodeId()

Return the immutable id for the default node that should be activated when this flow is entered.

Returns:String: the id of the start node
Since: 2.2

getSwitches	back to summary
public abstract Map<String, SwitchNode> getSwitches() Return an immutable data structure containing all of the switch nodes declared for this flow. Returns:Map<String, SwitchNode> the switch nodes for this flow Since 2.2

getSwitches

back to summary

public abstract Map<String, SwitchNode> getSwitches()

Return an immutable data structure containing all of the switch nodes declared for this flow.

Returns:Map<String, SwitchNode>: the switch nodes for this flow
Since: 2.2

getViews	back to summary
public abstract List<ViewNode> getViews() Return an immutable data structure containing all of the view nodes declared for this flow. Returns:List<ViewNode> the view nodes for this flow Since 2.2

getViews

back to summary

public abstract List<ViewNode> getViews()

Return an immutable data structure containing all of the view nodes declared for this flow.

Returns:List<ViewNode>: the view nodes for this flow
Since: 2.2

public abstract Class Flow

Constructor Summary

Method Summary

Constructor Detail

Method Detail