Constructor Detail

• Flow

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

  Returns:

  the id.

  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.

  Returns:

  the defining document id

  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.

  Returns:

  the id of the start node

  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. Any FlowScoped beans declared for this flow must remain in scope until after control returns from the method referenced by this MethodExpression.

  Returns:

  the MethodExpresion for the finalizer.

  Since:

  2.2

• getInitializer

  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:

  the MethodExpresion for the initializer.

  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(jakarta.faces.context.FacesContext, jakarta.faces.flow.Flow, jakarta.faces.flow.Flow, jakarta.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 a FlowCallNode that causes the transition to a new flow.

  Returns:

  the inbound parameters

  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.

  Returns:

  the view nodes 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.

  Returns:

  the return nodes 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.

  Returns:

  the switch nodes 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.

  Returns:

  the flow call nodes for this flow

  Since:

  2.2

• getFlowCall

  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 - the flow for which the FlowCallNode is to be returned

  Returns:

  a FlowCallNode for the argument flow or null

  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.

  Returns:

  the method call nodes for this flow

  Since:

  2.2

• getNode

  public abstract FlowNode getNode(java.lang.String nodeId)

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

  Parameters:

  nodeId - the node id for which the FlowNode is to be returned

  Returns:

  the FlowNode or null

• getNavigationCases

  public abstract java.util.Map<java.lang.String,java.util.Set<NavigationCase>> getNavigationCases()

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

  Returns:

  the navigation cases,

• getClientWindowFlowId

  public abstract java.lang.String getClientWindowFlowId(ClientWindow curWindow)

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

  Parameters:

  curWindow - the

  Returns:

  the generated client window id for this flow.

  Since:

  2.2