Package javax.faces.flow
Annotation Type 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 ofjavax.enterprise.inject.spi.Extension
that implements the semantics such that beans with this annotation are created when the user enters into the specifiedFlow
, and de-allocated when the user exits the specifiedFlow
. SeeFlowHandler.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 java.lang.String
value
Must be equivalent to theFlow.getId()
of a defined flow for this application.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
definingDocumentId
-
-
-
Element Detail
-
value
java.lang.String value
Must be equivalent to the
Flow.getId()
of a defined flow for this application.- Since:
- 2.2
-
-