Top Description Inners Constructors Methods
jakarta.faces.flow.builder

public abstract Class NavigationCaseBuilder

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.faces.flow.builder.NavigationCaseBuilderImpl
Imports
jakarta.el.ValueExpression

Create a navigation case in the current jakarta.faces.flow.Flow.

Since
2.2

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract class
NavigationCaseBuilder.RedirectBuilder

Allows populating the redirect with parameters and setting the includeViewParams option.

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public abstract NavigationCaseBuilder

Returns:

the builder instance
condition(String
the <if>
condition)

Set the if of the current navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
condition(ValueExpression
the <if>
condition)

Set the if of the current navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
fromAction(String
the from-action
fromAction)

Set the from-action of the current navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
fromOutcome(String
the from-outcome
fromOutcome)

Set the from-outcome of the current navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
fromViewId(String
the from-view-id
fromViewId)

Set the from-view-id of the current navigation case.

public abstract NavigationCaseBuilder.RedirectBuilder

Returns:

the builder instance
redirect()

Create a redirect within this navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
toFlowDocumentId(String
the to-flow-document-id
toFlowDocumentId)

Set the to-flow-document-id of the current navigation case.

public abstract NavigationCaseBuilder

Returns:

the builder instance
toViewId(String
the to-view-id
toViewId)

Set the to-view-id of the current navigation case.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

NavigationCaseBuilderback to summary
public NavigationCaseBuilder()

Method Detail

conditionback to summary
public abstract NavigationCaseBuilder condition(String condition)

Set the if of the current navigation case.

Parameters
condition:String

the <if>

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
conditionback to summary
public abstract NavigationCaseBuilder condition(ValueExpression condition)

Set the if of the current navigation case.

Parameters
condition:ValueExpression

the <if>

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
fromActionback to summary
public abstract NavigationCaseBuilder fromAction(String fromAction)

Set the from-action of the current navigation case.

Parameters
fromAction:String

the from-action

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
fromOutcomeback to summary
public abstract NavigationCaseBuilder fromOutcome(String fromOutcome)

Set the from-outcome of the current navigation case.

Parameters
fromOutcome:String

the from-outcome

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
fromViewIdback to summary
public abstract NavigationCaseBuilder fromViewId(String fromViewId)

Set the from-view-id of the current navigation case.

Parameters
fromViewId:String

the from-view-id

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
redirectback to summary
public abstract NavigationCaseBuilder.RedirectBuilder redirect()

Create a redirect within this navigation case.

Returns:NavigationCaseBuilder.RedirectBuilder

the builder instance

Since
2.2
toFlowDocumentIdback to summary
public abstract NavigationCaseBuilder toFlowDocumentId(String toFlowDocumentId)

Set the to-flow-document-id of the current navigation case.

Parameters
toFlowDocumentId:String

the to-flow-document-id

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
toViewIdback to summary
public abstract NavigationCaseBuilder toViewId(String toViewId)

Set the to-view-id of the current navigation case.

Parameters
toViewId:String

the to-view-id

Returns:NavigationCaseBuilder

the builder instance

Exceptions
NullPointerException:
if any of the parameters are null
Since
2.2
jakarta.faces.flow.builder back to summary

public abstract Class NavigationCaseBuilder.RedirectBuilder

extends Object
Class Inheritance
  • java.lang.Object
  • jakarta.faces.flow.builder.NavigationCaseBuilder.RedirectBuilder
Known Direct Subclasses
com.sun.faces.flow.builder.NavigationCaseBuilderImpl.RedirectBuilderImpl

Allows populating the redirect with parameters and setting the includeViewParams option.

Since
2.2

Constructor Summary

AccessConstructor and Description
public
RedirectBuilder()

Method Summary

Modifier and TypeMethod and Description
public abstract NavigationCaseBuilder.RedirectBuilder

Returns:

the builder instance
includeViewParams()

Indicates the current redirect should include view parameters.

public abstract NavigationCaseBuilder.RedirectBuilder

Returns:

the builder instance
parameter(String
the name of the redirect parameter
name, String
the value of the redirect parameter. May not be a ValueExpression.
value)

Add a parameter to the redirect.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

RedirectBuilderback to summary
public RedirectBuilder()

Method Detail

includeViewParamsback to summary
public abstract NavigationCaseBuilder.RedirectBuilder includeViewParams()

Indicates the current redirect should include view parameters.

Returns:NavigationCaseBuilder.RedirectBuilder

the builder instance

Since
2.2
parameterback to summary
public abstract NavigationCaseBuilder.RedirectBuilder parameter(String name, String value)

Add a parameter to the redirect.

Parameters
name:String

the name of the redirect parameter

value:String

the value of the redirect parameter. May not be a ValueExpression.

Returns:NavigationCaseBuilder.RedirectBuilder

the builder instance

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