パッケージ jakarta.faces.flow

クラス Flow


  • public abstract class Flow
    extends ObjectSE

    Flow は、FacesFlow の実行時表現です。ランタイムによってサービスが開始されると、このクラスのインスタンスは不変になります。インスタンスはアプリケーション内のフローのすべての使用箇所で共有されるため、実装はスレッドセーフである必要があります。

    導入:
    2.2
    • コンストラクターの詳細

      • Flow

        public Flow()
    • メソッドの詳細

      • getId

        public abstract StringSE getId()

        このフローの不変 ID を返します。これは、定義ドキュメント(アプリケーション構成リソースファイルなど)内で一意である必要がありますが、アプリケーション全体で一意である必要はありません。

        戻り値:
        ID。
        導入:
        2.2
      • getDefiningDocumentId

        public abstract StringSE getDefiningDocumentId()

        引数フローが定義されているドキュメントの不変のアプリケーション固有識別子を返します。

        戻り値:
        定義するドキュメント ID
        導入:
        2.2
      • getStartNodeId

        public abstract StringSE getStartNodeId()

        このフローに入るときにアクティブ化されるデフォルトノードの不変 ID を返します。

        戻り値:
        開始ノードの ID
        導入:
        2.2
      • getFinalizer

        public abstract MethodExpression getFinalizer()

        このフローを終了する前に発生する最後のこととして、ランタイムによって呼び出される必要がある MethodExpression を返します。このフローに対して宣言された FlowScoped Bean は、この MethodExpression によって参照されるメソッドから制御が戻るまで、スコープ内に留まる必要があります。

        戻り値:
        ファイナライザの MethodExpresion
        導入:
        2.2
      • getInitializer

        public abstract MethodExpression getInitializer()

        このフローに対して宣言された FlowScoped Bean をアクティブ化した直後にランタイムによって呼び出される必要がある MethodExpression を返します。

        戻り値:
        イニシャライザーの MethodExpresion
        導入:
        2.2
      • getViews

        public abstract ListSE<ViewNode> getViews()

        このフローに対して宣言されたすべてのビューノードを含む不変のデータ構造を返します。

        戻り値:
        このフローのビューノード
        導入:
        2.2
      • getReturns

        public abstract MapSE<StringSE,​ReturnNode> getReturns()

        このフローに対して宣言されたすべての戻りノードを含む不変のデータ構造を返します。

        戻り値:
        このフローのリターンノード。
        導入:
        2.2
      • getSwitches

        public abstract MapSE<StringSE,​SwitchNode> getSwitches()

        このフローに対して宣言されたすべてのスイッチノードを含む不変のデータ構造を返します。

        戻り値:
        このフローのスイッチノード
        導入:
        2.2
      • getFlowCalls

        public abstract MapSE<StringSE,​FlowCallNode> getFlowCalls()

        このフローに対して宣言されたすべてのフロー呼び出しノードを含む不変のデータ構造を返します。

        戻り値:
        このフローのフロー呼び出しノード
        導入:
        2.2
      • getFlowCall

        public abstract FlowCallNode getFlowCall​(Flow targetFlow)

        このフローからの targetFlow の呼び出しを表す FlowCallNode、またはこのフローから targetFlow に到達できない場合は null を返します。

        パラメーター:
        targetFlow - FlowCallNode が返されるフロー
        戻り値:
        引数フローの FlowCallNode または null
        導入:
        2.2
      • getMethodCalls

        public abstract ListSE<MethodCallNode> getMethodCalls()

        このフローに対して宣言されたすべてのメソッド呼び出しノードを含む不変のデータ構造を返します。

        戻り値:
        このフローのメソッド呼び出しノード
        導入:
        2.2
      • getNode

        public abstract FlowNode getNode​(StringSE nodeId)

        ID でジェネリクス FlowNode を返します。見つからない場合は null を返します。

        パラメーター:
        nodeId - FlowNode が返されるノード ID
        戻り値:
        FlowNode または null
      • getNavigationCases

        public abstract MapSE<StringSE,​SetSE<NavigationCase>> getNavigationCases()

        このフロー内のナビゲーションケースの変更不可能なビューを返します。

        戻り値:
        ナビゲーションケース
      • getClientWindowFlowId

        public abstract StringSE getClientWindowFlowId​(ClientWindow curWindow)

        ClientWindow の ID を取得し、"_" と getId() からの戻り値を追加します。結果を返します。

        パラメーター:
        curWindow -
        戻り値:
        このフローに対して生成されたクライアントウィンドウ ID。
        導入:
        2.2