パッケージ jakarta.faces.application

クラス NavigationCase

java.lang.ObjectSE
jakarta.faces.application.NavigationCase
既知の直属サブクラス
NavigationCaseWrapper
public class NavigationCase extends ObjectSE

NavigationCase は、ナビゲーションルールベースの <navigation-case> とこの <navigation-case> が兄弟である <from-view-id>  を表します。

導入:
2.0

  • コンストラクターの詳細

  • メソッドの詳細

    • getActionURL

      public URLSE getActionURL(FacesContext context) throws MalformedURLExceptionSE

      URL のパス部分に ViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String) を使用して、この NavigationCase インスタンスへの絶対 URL を構築します。

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      アクション URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。

    • getResourceURL

      public URLSE getResourceURL(FacesContext context) throws MalformedURLExceptionSE

      URL のパス部分に ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String) を使用して、この NavigationCase インスタンスへの絶対 URL を構築します。

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      リソース URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。

    • getRedirectURL

      public URLSE getRedirectURL(FacesContext context) throws MalformedURLExceptionSE

      URL のパス部分で ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean) を使用して、この NavigationCase インスタンスへの「リダイレクト」に適した絶対 URL を構築します。

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      リダイレクト URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。

    • getBookmarkableURL

      public URLSE getBookmarkableURL(FacesContext context) throws MalformedURLExceptionSE

      URL のパス部分に ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean) を使用して、この NavigationCase インスタンスへのブックマーク可能なリンクに適した絶対 URL を構築します。この URL には、ビュー内のメタデータとして指定されたビューパラメーターを含めることができます。

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      ブックマーク可能な URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。

    • getFromViewId

      public StringSE getFromViewId()

      この <navigation-case> がネストされている <navigation-rule> の <from-view-id> を返します。

      戻り値:
      viedId から。

    • getFromAction

      public StringSE getFromAction()

      この <navigation-case> の <from-action> を返します

      戻り値:
      from アクション。

    • getFromOutcome

      public StringSE getFromOutcome()

      この <navigation-case> の <from-outcome> を返します

      戻り値:
      からの結果。

    • getToViewId

      public StringSE getToViewId(FacesContext context)

      この <navigation-case> の <to-view-id> を評価します

      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      ナビゲートするビュー ID

    • getToFlowDocumentId

      public StringSE getToFlowDocumentId()

      このナビゲーションケースがフロー呼び出しを表す場合、このプロパティは、getFromOutcome() からの戻り値によって ID が指定されたフローが定義されている documentId です。実装では、このメソッドをオーバーライドして、対応するアプリケーション構成リソース要素で定義された値を返す必要があります。基本実装では、空の文字列が返されます。

      戻り値:
      toFlow ドキュメント ID。
      導入:
      2.2

    • hasCondition

      public boolean hasCondition()

      このナビゲーションケースに関連付けられた <if> 要素があるかどうかをテストします。

      戻り値:
      この <navigation-case> に関連付けられている <if> 要素がある場合は true、それ以外の場合は false

    • getCondition

      public BooleanSE getCondition(FacesContext context)

      この <navigation-case> の <if> を評価します（ある場合）。評価される式は、文字列としてコンストラクターに渡されます。式が評価されるとき、その値は通常の Jakarta Expression Language 強制ルールに従って boolean に強制変換される必要があります。

      Note は、式の評価またはその値の取得プロセス中に発生した例外をスローします。
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      この <navigation-case> に関連付けられている <if> 要素がない場合は null、それ以外の場合は条件の評価結果を返します

    • getParameters

      public MapSE<StringSE,ListSE<StringSE>> getParameters()

      リダイレクトが必要なナビゲーションケースに含めるパラメーターを返します。パラメーターが定義されていない場合、null が返されます。Map のキーはパラメーター名です。各キーの対応する値は、変換されていない値の List です。

      戻り値:
      パラメーターのリスト、または null

    • isRedirect

      public boolean isRedirect()

      この <navigation-case> の <redirect> 値を返します。新しいビューに ExternalContext.redirect(String) を介してナビゲートする必要がある場合、これは true になります。

      戻り値:
      これがリダイレクトの場合は true、それ以外の場合は false。

    • isIncludeViewParams

      public boolean isIncludeViewParams()

      この <navigation-case> の <redirect> 値を返します。ビューのパラメーターをリダイレクト URL にエンコードする必要がある場合、これは true になります。(リダイレクトの場合にのみ適用されます)

      戻り値:
      ビューパラメーターを含める場合は true、それ以外の場合は false。

    • equals

      public boolean equals(ObjectSE o)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString