## Uses of Class
javax.faces.flow.Flow

- Packages that use Flow
  Package | Description
  --- | ---
  javax.faces.application | APIs that are used to link an application's business logic objects to JavaServer Faces, as well as convenient pluggable mechanisms to manage the execution of an application that is based on JavaServer Faces.
  javax.faces.flow | The runtime API for Faces Flows.
  javax.faces.flow.builder | Classes for declaring a Faces Flow.

- - ### Uses of Flow in javax.faces.application

    Methods in javax.faces.application with parameters of type Flow
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConfigurableNavigationHandlerWrapper.`inspectFlow(FacesContext context, Flow flow)`
    `void` | ConfigurableNavigationHandler.`inspectFlow(FacesContext context, Flow flow)` Called by the flow system to cause the flow to be inspected for navigation rules.

  - ### Uses of Flow in javax.faces.flow

    Methods in javax.faces.flow that return Flow
    Modifier and Type | Method and Description
    --- | ---
    `Flow` | FlowHandler.`getCurrentFlow()` Convenience overload that calls `FacesContext.getCurrentInstance()` and then calls through to `FlowHandler.getCurrentFlow(javax.faces.context.FacesContext)`.
    `abstract Flow` | FlowHandler.`getCurrentFlow(FacesContext context)` Return the currently active `Flow` for the argument `FacesContext`, or `null` if no flow is active.
    `abstract Flow` | FlowHandler.`getFlow(FacesContext context, String definingDocumentId, String id)` Return the `Flow` whose `id` is equivalent to the argument `id`, within the scope of the argument `definingDocument`.

    Methods in javax.faces.flow with parameters of type Flow
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | FlowHandler.`addFlow(FacesContext context, Flow toAdd)` Add the argument `Flow` to the collection of `Flow`s known to the current application.
    `abstract FlowCallNode` | Flow.`getFlowCall(Flow targetFlow)` Return the `FlowCallNode` that represents calling the `targetFlow` from this flow, or `null` if `targetFlow` cannot be reached from this flow.
    `abstract void` | FlowHandler.`transition(FacesContext context, Flow sourceFlow, Flow targetFlow, FlowCallNode outboundCallNode, String toViewId)` Perform a transition in the flow graph for the current user's `ClientWindow`.

  - ### Uses of Flow in javax.faces.flow.builder

    Methods in javax.faces.flow.builder that return Flow
    Modifier and Type | Method and Description
    --- | ---
    `abstract Flow` | FlowBuilder.`getFlow()` Called as the last step in flow definition, this method must perform any implementation specific initialization and return the built `Flow`.

Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.