Package javax.faces.flow.builder
Class FlowCallBuilder
java.lang.Object
javax.faces.flow.builder.FlowCallBuilder
- All Implemented Interfaces:
NodeBuilder
Create a flow call node in the current Flow
.
- Since:
- 2.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract FlowCallBuilder
flowReference
(String flowDocumentId, String flowId) Define the flow reference of the called flow.abstract FlowCallBuilder
Mark this node as the start node in the flow.abstract FlowCallBuilder
outboundParameter
(String name, String value) Define an outbound parameter for the flow call.abstract FlowCallBuilder
outboundParameter
(String name, ValueExpression value) Define an outbound parameter for the flow call.
-
Constructor Details
-
FlowCallBuilder
public FlowCallBuilder()
-
-
Method Details
-
flowReference
Define the flow reference of the called flow.
- Parameters:
flowDocumentId
- the document id of the called flow. May not benull
, but may be the empty string.flowId
- the id of the called flow. May not benull
- Returns:
- the builder instance
- Throws:
NullPointerException
- if any of the parameters arenull
- Since:
- 2.2
-
outboundParameter
Define an outbound parameter for the flow call.
- Parameters:
name
- the name of the parametervalue
- the value of the parameter- Returns:
- the builder instance
- Throws:
NullPointerException
- if any of the parameters arenull
- Since:
- 2.2
-
outboundParameter
Define an outbound parameter for the flow call.
- Parameters:
name
- the name of the parametervalue
- the value of the parameter- Returns:
- the builder instance
- Throws:
NullPointerException
- if any of the parameters arenull
- Since:
- 2.2
-
markAsStartNode
Description copied from interface:NodeBuilder
Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node.
- Specified by:
markAsStartNode
in interfaceNodeBuilder
- Returns:
- the builder instance
-