com.sun.faces.flow.builder

Class FlowCallBuilderImpl

java.lang.Object

javax.faces.flow.builder.FlowCallBuilder

com.sun.faces.flow.builder.FlowCallBuilderImpl

All Implemented Interfaces:

javax.faces.flow.builder.NodeBuilder

public class FlowCallBuilderImpl
extends javax.faces.flow.builder.FlowCallBuilder

Constructor Summary

Constructors

Constructor and Description
FlowCallBuilderImpl(FlowBuilderImpl root, String id)

Method Summary

Modifier and Type	Method and Description
javax.faces.flow.builder.FlowCallBuilder	flowReference(String flowDocumentId, String flowId) Define the flow reference of the called flow.
javax.faces.flow.builder.FlowCallBuilder	markAsStartNode() Mark this node as the start node in the flow.
javax.faces.flow.builder.FlowCallBuilder	outboundParameter(String name, String value) Define an outbound parameter for the flow call.
javax.faces.flow.builder.FlowCallBuilder	outboundParameter(String name, javax.el.ValueExpression value) Define an outbound parameter for the flow call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowCallBuilderImpl

public FlowCallBuilderImpl(FlowBuilderImpl root,
                           String id)

Method Detail

flowReference

public javax.faces.flow.builder.FlowCallBuilder flowReference(String flowDocumentId,
                                                              String flowId)

Description copied from class: javax.faces.flow.builder.FlowCallBuilder

Define the flow reference of the called flow.

Specified by:

flowReference in class javax.faces.flow.builder.FlowCallBuilder

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

outboundParameter

public javax.faces.flow.builder.FlowCallBuilder outboundParameter(String name,
                                                                  javax.el.ValueExpression value)

Description copied from class: javax.faces.flow.builder.FlowCallBuilder

Define an outbound parameter for the flow call.

Specified by:

outboundParameter in class javax.faces.flow.builder.FlowCallBuilder

Parameters:

name - the name of the parameter

value - the value of the parameter

Returns:

the builder instance

outboundParameter

public javax.faces.flow.builder.FlowCallBuilder outboundParameter(String name,
                                                                  String value)

Description copied from class: javax.faces.flow.builder.FlowCallBuilder

Define an outbound parameter for the flow call.

Specified by:

outboundParameter in class javax.faces.flow.builder.FlowCallBuilder

Parameters:

name - the name of the parameter

value - the value of the parameter

Returns:

the builder instance

markAsStartNode

public javax.faces.flow.builder.FlowCallBuilder markAsStartNode()

Description copied from interface: javax.faces.flow.builder.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 javax.faces.flow.builder.NodeBuilder

Specified by:

markAsStartNode in class javax.faces.flow.builder.FlowCallBuilder

Returns:

the builder instance