Package javax.faces.flow

Annotation Interface FlowScoped

@NormalScope @Inherited @Documented @Target(TYPE) @Retention(RUNTIME) public @interface FlowScoped

FlowScoped is a CDI scope that causes the runtime to consider classes with this annotation to be in the scope of the specified Flow. The implementation must provide an implementation of javax.enterprise.inject.spi.Extension that implements the semantics such that beans with this annotation are created when the user enters into the specified Flow, and de-allocated when the user exits the specified 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 flow entry and exit.

Since:
2.2

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Must be equivalent to the Flow.getId() of a defined flow for this application.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    definingDocumentId
    If not empty, declare the defining document id within which the Flow referenced by value() is unique.

  • Element Details

    • value

      String value

      Must be equivalent to the Flow.getId() of a defined flow for this application.

      Since:
      2.2

    • definingDocumentId

      String definingDocumentId

      If not empty, declare the defining document id within which the Flow referenced by value() is unique. If empty the, the runtime assumes that all flow ids are unique within the scope of the application.

      Since:
      2.2
      Default:
      ""