Top Description Constructors Methods
jakarta.faces.flow.builder

public abstract Class FlowCallBuilder

extends Object
implements NodeBuilder
Class Inheritance
All Implemented Interfaces
jakarta.faces.flow.builder.NodeBuilder
Imports
jakarta.el.ValueExpression

Create a flow call node in the current jakarta.faces.flow.Flow.

Since
2.2

Constructor Summary

AccessConstructor and Description
public
FlowCallBuilder()

Method Summary

Modifier and TypeMethod and Description
public abstract FlowCallBuilder

Returns:

the builder instance
flowReference(String
the document id of the called flow. May not be null, but may be the empty string.
flowDocumentId, String
the id of the called flow. May not be null
flowId)

Define the flow reference of the called flow.

public abstract FlowCallBuilder
markAsStartNode()

Redeclares jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

Mark this node as the start node in the flow.

public abstract FlowCallBuilder

Returns:

the builder instance
outboundParameter(String
the name of the parameter
name, ValueExpression
the value of the parameter
value)

Define an outbound parameter for the flow call.

public abstract FlowCallBuilder

Returns:

the builder instance
outboundParameter(String
the name of the parameter
name, String
the value of the parameter
value)

Define an outbound parameter for the flow call.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

FlowCallBuilderback to summary
public FlowCallBuilder()

Method Detail

flowReferenceback to summary
public abstract FlowCallBuilder flowReference(String flowDocumentId, String flowId)

Define the flow reference of the called flow.

Parameters
flowDocumentId:String

the document id of the called flow. May not be null, but may be the empty string.

flowId:String

the id of the called flow. May not be null

Returns:FlowCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
markAsStartNodeback to summary
public abstract FlowCallBuilder markAsStartNode()

Redeclares jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

Doc from jakarta.faces.flow.builder.NodeBuilder.markAsStartNode.

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.

Returns:FlowCallBuilder

the builder instance

Annotations
@Override
outboundParameterback to summary
public abstract FlowCallBuilder outboundParameter(String name, ValueExpression value)

Define an outbound parameter for the flow call.

Parameters
name:String

the name of the parameter

value:ValueExpression

the value of the parameter

Returns:FlowCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
outboundParameterback to summary
public abstract FlowCallBuilder outboundParameter(String name, String value)

Define an outbound parameter for the flow call.

Parameters
name:String

the name of the parameter

value:String

the value of the parameter

Returns:FlowCallBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2