Class NavigationCaseWrapper

    • Constructor Detail

      • NavigationCaseWrapper

        @Deprecated
        public NavigationCaseWrapper​()
        Deprecated. Use the other constructor taking the implementation being wrapped.
      • NavigationCaseWrapper

        public NavigationCaseWrapper​(NavigationCase wrapped)

        If this navigation case has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

        Parameters:
        wrapped - The implementation being wrapped.
        Since:
        2.3
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class NavigationCase
      • getCondition

        public java.lang.Boolean getCondition​(FacesContext context)
        Description copied from class: NavigationCase

        Evaluates the <if> for this <navigation-case>, if any. The expression to be evaluated is passed into the constructor as a string. When the expression is evaluated, its value must be coerced into a boolean per the normal EL coercion rules.

        Note throws any exceptions encountered during the process of evaluating the expression or obtaining its value.
        Overrides:
        getCondition in class NavigationCase
        Parameters:
        context - the FacesContext for the current request
        Returns:
        null if there is no <if> element associated with this <navigation-case>, otherwise return the evaluation result of the condition
      • getFromAction

        public java.lang.String getFromAction​()
        Description copied from class: NavigationCase

        Return the <from-action> for this <navigation-case>

        Overrides:
        getFromAction in class NavigationCase
        Returns:
        the from action.
      • getFromOutcome

        public java.lang.String getFromOutcome​()
        Description copied from class: NavigationCase

        Return the <from-outcome> for this <navigation-case>

        Overrides:
        getFromOutcome in class NavigationCase
        Returns:
        the from outcome.
      • getFromViewId

        public java.lang.String getFromViewId​()
        Description copied from class: NavigationCase

        Return the <from-view-id> of the <navigation-rule> inside which this <navigation-case> is nested.

        Overrides:
        getFromViewId in class NavigationCase
        Returns:
        the from viedId.
      • getParameters

        public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameters​()
        Description copied from class: NavigationCase

        Return the parameters to be included for navigation cases requiring a redirect. If no parameters are defined, null will be returned. The keys in the Map are parameter names. For each key, the corresponding value is a List of unconverted values.

        Overrides:
        getParameters in class NavigationCase
        Returns:
        the list of parameters, or null
      • getToViewId

        public java.lang.String getToViewId​(FacesContext context)
        Description copied from class: NavigationCase

        Evaluates the <to-view-id> for this <navigation-case>

        Overrides:
        getToViewId in class NavigationCase
        Parameters:
        context - the FacesContext for the current request
        Returns:
        the view ID that should be navigated to
      • getToFlowDocumentId

        public java.lang.String getToFlowDocumentId​()
        Description copied from class: NavigationCase

        If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is given by the return from NavigationCase.getFromOutcome() is defined. Implementations must override this method to return the value defined in the corresponding application configuration resources element. The base implementation returns the empty string.

        Overrides:
        getToFlowDocumentId in class NavigationCase
        Returns:
        the toFlow documentId.
      • hasCondition

        public boolean hasCondition​()
        Description copied from class: NavigationCase

        Test if this navigation case has an associated <if> element.

        Overrides:
        hasCondition in class NavigationCase
        Returns:
        true if there's an <if> element associated with this <navigation-case>, otherwise false
      • isIncludeViewParams

        public boolean isIncludeViewParams​()
        Description copied from class: NavigationCase

        Return the <redirect> value for this <navigation-case>. This will be true if the view parametets should be encoded into the redirect URL (only applies to redirect case)

        Overrides:
        isIncludeViewParams in class NavigationCase
        Returns:
        true if view parameters are to be included, false otherwise.