Package jakarta.faces.flow.builder

Class FlowCallBuilder

  • All Implemented Interfaces:
    NodeBuilder
    public abstract class FlowCallBuilder
extends Object
implements NodeBuilder

    Create a flow call node in the current Flow.

    Since:
    2.2

    • Constructor Detail

      • FlowCallBuilder

        public FlowCallBuilder()

    • Method Detail

      • flowReference

        public abstract FlowCallBuilder flowReference​(String flowDocumentId,
                                              String flowId)

        Define the flow reference of the called flow.

        Parameters:
        flowDocumentId - the document id of the called flow. May not be null, but may be the empty string.
        flowId - the id of the called flow. May not be null
        Returns:
        the builder instance
        Throws:
        NullPointerException - if any of the parameters are null
        Since:
        2.2

      • outboundParameter

        public abstract FlowCallBuilder outboundParameter​(String name,
                                                  ValueExpression value)

        Define an outbound parameter for the flow call.

        Parameters:
        name - the name of the parameter
        value - the value of the parameter
        Returns:
        the builder instance
        Throws:
        NullPointerException - if any of the parameters are null
        Since:
        2.2

      • outboundParameter

        public abstract FlowCallBuilder outboundParameter​(String name,
                                                  String value)

        Define an outbound parameter for the flow call.

        Parameters:
        name - the name of the parameter
        value - the value of the parameter
        Returns:
        the builder instance
        Throws:
        NullPointerException - if any of the parameters are null
        Since:
        2.2

      • markAsStartNode

        public abstract FlowCallBuilder 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 interface NodeBuilder
        Returns:
        the builder instance