Package jakarta.faces.flow
Class FlowHandler
- java.lang.Object
-
- jakarta.faces.flow.FlowHandler
-
public abstract class FlowHandler extends Object
- Since:
- 2.2
-
-
Field Summary
Fields Modifier and Type Field Description static String
FLOW_ID_REQUEST_PARAM_NAME
static String
NULL_FLOW
static String
TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME
-
Constructor Summary
Constructors Constructor Description FlowHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
addFlow(FacesContext context, Flow toAdd)
abstract void
clientWindowTransition(FacesContext context)
Flow
getCurrentFlow()
abstract Flow
getCurrentFlow(FacesContext context)
abstract Map<Object,Object>
getCurrentFlowScope()
abstract Flow
getFlow(FacesContext context, String definingDocumentId, String id)
abstract String
getLastDisplayedViewId(FacesContext context)
abstract boolean
isActive(FacesContext context, String definingDocument, String id)
abstract void
popReturnMode(FacesContext context)
abstract void
pushReturnMode(FacesContext context)
abstract void
transition(FacesContext context, Flow sourceFlow, Flow targetFlow, FlowCallNode outboundCallNode, String toViewId)
-
-
-
Field Detail
-
FLOW_ID_REQUEST_PARAM_NAME
public static final String FLOW_ID_REQUEST_PARAM_NAME
- See Also:
- Constant Field Values
-
NULL_FLOW
public static final String NULL_FLOW
- See Also:
- Constant Field Values
-
TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME
public static final String TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFlow
public abstract Flow getFlow(FacesContext context, String definingDocumentId, String id)
-
addFlow
public abstract void addFlow(FacesContext context, Flow toAdd)
-
getCurrentFlow
public abstract Flow getCurrentFlow(FacesContext context)
-
getCurrentFlow
public Flow getCurrentFlow()
-
transition
public abstract void transition(FacesContext context, Flow sourceFlow, Flow targetFlow, FlowCallNode outboundCallNode, String toViewId)
-
isActive
public abstract boolean isActive(FacesContext context, String definingDocument, String id)
-
clientWindowTransition
public abstract void clientWindowTransition(FacesContext context)
-
getLastDisplayedViewId
public abstract String getLastDisplayedViewId(FacesContext context)
-
pushReturnMode
public abstract void pushReturnMode(FacesContext context)
-
popReturnMode
public abstract void popReturnMode(FacesContext context)
-
-