クラス NavigationCase
- java.lang.ObjectSE
-
- jakarta.faces.application.NavigationCase
- 既知の直属サブクラス
NavigationCaseWrapper
public class NavigationCase extends ObjectSE
NavigationCase は、ナビゲーションルールベースの
<navigation-case>とこの<navigation-case>が兄弟である<from-view-id>を表します。- 導入:
- 2.0
コンストラクター概要
コンストラクター コンストラクター 説明 NavigationCase(StringSE fromViewId, StringSE fromAction, StringSE fromOutcome, StringSE condition, StringSE toViewId, StringSE toFlowDocumentId, MapSE<StringSE,ListSE<StringSE>> parameters, boolean redirect, boolean includeViewParams)提供された引数に基づいて、新しいNavigationCaseを作成します。NavigationCase(StringSE fromViewId, StringSE fromAction, StringSE fromOutcome, StringSE condition, StringSE toViewId, MapSE<StringSE,ListSE<StringSE>> parameters, boolean redirect, boolean includeViewParams)提供された引数に基づいて、新しいNavigationCaseを作成します。
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 booleanequals(ObjectSE o)URLSEgetActionURL(FacesContext context)URL のパス部分にViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String)を使用して、このNavigationCaseインスタンスへの絶対 URL を構築します。URLSEgetBookmarkableURL(FacesContext context)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 を構築します。BooleanSEgetCondition(FacesContext context)この<navigation-case>の<if>を評価します(ある場合)。StringSEgetFromAction()この<navigation-case>の<from-action>を返しますStringSEgetFromOutcome()この<navigation-case>の<from-outcome>を返しますStringSEgetFromViewId()この<navigation-case>がネストされている<navigation-rule>の<from-view-id>を返します。MapSE<StringSE,ListSE<StringSE>>getParameters()リダイレクトが必要なナビゲーションケースに含めるパラメーターを返します。URLSEgetRedirectURL(FacesContext context)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 を構築します。URLSEgetResourceURL(FacesContext context)URL のパス部分にViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String)を使用して、このNavigationCaseインスタンスへの絶対 URL を構築します。StringSEgetToFlowDocumentId()このナビゲーションケースがフロー呼び出しを表す場合、このプロパティは、getFromOutcome()からの戻りによって ID が指定されたフローが定義されている documentId です。StringSEgetToViewId(FacesContext context)この<navigation-case>の<to-view-id>を評価しますbooleanhasCondition()このナビゲーションケースに関連付けられた<if>要素があるかどうかをテストします。inthashCode()booleanisIncludeViewParams()この<navigation-case>の<redirect>値を返します。booleanisRedirect()この<navigation-case>の<redirect>値を返します。StringSEtoString()
コンストラクターの詳細
NavigationCase
public NavigationCase(StringSE fromViewId, StringSE fromAction, StringSE fromOutcome, StringSE condition, StringSE toViewId, MapSE<StringSE,ListSE<StringSE>> parameters, boolean redirect, boolean includeViewParams)
提供された引数に基づいて新しい
NavigationCaseを構築します。標準のConfigurableNavigationHandlerでNavigationCaseがどのように使用されるかについては、Jakarta Faces Specification Document のセクション 7.4.2「デフォルト NavigationHandler アルゴリズム」を参照してください。- パラメーター:
fromViewId-getFromViewId()から戻るfromAction-getFromAction()から戻るfromOutcome-getFromOutcome()から戻るcondition-getCondition(jakarta.faces.context.FacesContext)の呼び出しによってValueExpressionとして解釈される文字列toViewId-getToViewId(jakarta.faces.context.FacesContext)から戻るparameters-getParameters()から戻るredirect-isRedirect()から戻るincludeViewParams-isIncludeViewParams()を返す
NavigationCase
public NavigationCase(StringSE fromViewId, StringSE fromAction, StringSE fromOutcome, StringSE condition, StringSE toViewId, StringSE toFlowDocumentId, MapSE<StringSE,ListSE<StringSE>> parameters, boolean redirect, boolean includeViewParams)
提供された引数に基づいて新しい
NavigationCaseを構築します。標準のConfigurableNavigationHandlerでNavigationCaseがどのように使用されるかについては、Jakarta Faces Specification Document のセクション 7.4.2「デフォルト NavigationHandler アルゴリズム」を参照してください。- パラメーター:
fromViewId-getFromViewId()から戻るfromAction-getFromAction()から戻るfromOutcome-getFromOutcome()から戻るcondition-getCondition(jakarta.faces.context.FacesContext)の呼び出しによってValueExpressionとして解釈される文字列toViewId-getToViewId(jakarta.faces.context.FacesContext)から戻るtoFlowDocumentId- toFlow ドキュメント ID。parameters-getParameters()から戻るredirect-isRedirect()から戻るincludeViewParams-isIncludeViewParams()を返す
メソッドの詳細
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)
この
Note は、式の評価またはその値の取得プロセス中に発生した例外をスローします。<navigation-case>の<if>を評価します(ある場合)。評価される式は、文字列としてコンストラクターに渡されます。式が評価されるとき、その値は通常の Jakarta Expression Language 強制ルールに従ってbooleanに強制変換される必要があります。- パラメーター:
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。