Package jakarta.faces.flow.builder

Class NavigationCaseBuilder

java.lang.Object
jakarta.faces.flow.builder.NavigationCaseBuilder
Direct Known Subclasses:
NavigationCaseBuilderImpl
public abstract class NavigationCaseBuilder extends Object

Create a navigation case in the current Flow.

Since:
2.2

  • Constructor Details

    • NavigationCaseBuilder

      public NavigationCaseBuilder()

  • Method Details

    • fromViewId

      public abstract NavigationCaseBuilder fromViewId(String fromViewId)

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

      Parameters:
      fromViewId - the from-view-id
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • fromAction

      public abstract NavigationCaseBuilder fromAction(String fromAction)

      Set the from-action of the current navigation case.

      Parameters:
      fromAction - the from-action
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • fromOutcome

      public abstract NavigationCaseBuilder fromOutcome(String fromOutcome)

      Set the from-outcome of the current navigation case.

      Parameters:
      fromOutcome - the from-outcome
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • toViewId

      public abstract NavigationCaseBuilder toViewId(String toViewId)

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

      Parameters:
      toViewId - the to-view-id
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • toFlowDocumentId

      public abstract NavigationCaseBuilder toFlowDocumentId(String toFlowDocumentId)

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

      Parameters:
      toFlowDocumentId - the to-flow-document-id
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • condition

      public abstract NavigationCaseBuilder condition(String condition)

      Set the if of the current navigation case.

      Parameters:
      condition - the <if>
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • condition

      public abstract NavigationCaseBuilder condition(jakarta.el.ValueExpression condition)

      Set the if of the current navigation case.

      Parameters:
      condition - the <if>
      Returns:
      the builder instance
      Throws:
      NullPointerException - if any of the parameters are null
      Since:
      2.2

    • redirect

      public abstract NavigationCaseBuilder.RedirectBuilder redirect()

      Create a redirect within this navigation case.

      Returns:
      the builder instance
      Since:
      2.2