パッケージ org.springframework.webflow.definition

インターフェース FlowDefinition

すべてのスーパーインターフェース:
Annotated
すべての既知の実装クラス:
Flow
public interface FlowDefinition extends Annotated
フローの定義。フローとは、実行されると単一のクライアントに代わってタスクを実行するプログラムです。

フロー定義は、実行可能なユーザータスクのブループリントを定義する、再利用可能な自己完結型のコントローラーモジュールです。フローは通常、Web アプリケーション内で制御されたナビゲーションまたはダイアログを調整し、状態としてモデル化された一連の手順で実行されるビジネスプロセス / ゴールの達成をユーザーにガイドします。

構造的には、フロー定義は一連の状態から構成されます。state は、フロー内で動作が実行されるポイントです。たとえば、ビューの表示、アクションの実行、サブフローの生成、フローの終了などです。状態の種類によって、ポリモーフィックな方法でさまざまな動作が実行されます。ほとんどの状態は transitionable states です。つまり、イベントに応答して、フローをある状態から別の状態に移行できます。

各フローには、プログラムの開始点を定義する start state が 1 つだけあります。

このインターフェースは、フローの識別子、状態、その他の定義属性を公開します。フロー実行時のツールやユーザーコードによるイントロスペクションに適しています。

フロー定義には属性でアノテーションを付けることができます。

作成者:
Keith Donald, Erwin Vervaet

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    destroy()
    このフロー定義を破棄し、すべてのリソースを解放します。
    org.springframework.context.ApplicationContext
    getApplicationContext()
    このフロー定義で使用されるアプリケーションオブジェクトとサービスをホストするアプリケーションコンテキストへの参照を返します。
    ClassLoaderSE
    getClassLoader()
    このフロー定義でクラスをロードするために使用するクラスローダーを返します。
    StringSE
    getId()
    このフローの一意の ID を返します。
    StringSE[]
    getPossibleOutcomes()
    このフローが到達できる可能性のある結果を返します。
    StateDefinition
    getStartState()
    このフローの開始点を返します。
    StateDefinition
    getState(StringSE id)
    指定された ID を持つ状態定義を返します。
    boolean
    inDevelopment()
    このフロー定義が現在開発中（開発モードで実行中）の場合は true を返します。

    インターフェース org.springframework.webflow.core.Annotated から継承されたメソッド

    getAttributes, getCaption, getDescription

  • メソッドの詳細

    • getId

      StringSE getId()
      このフローの一意の ID を返します。
      戻り値:
      フロー ID

    • getStartState

      StateDefinition getStartState()
      このフローの開始点を返します。
      戻り値:
      開始状態

    • getState

      StateDefinition getState(StringSE id) throws IllegalArgumentExceptionSE
      指定された ID を持つ状態定義を返します。
      パラメーター:
      id - 状態 ID
      戻り値:
      状態の定義
      例外:
      IllegalArgumentExceptionSE - この ID を持つ状態が存在しない場合

    • getPossibleOutcomes

      StringSE[] getPossibleOutcomes()
      このフローが到達できる可能性のある結果を返します。
      戻り値:
      起こりうる結果

    • getClassLoader

      ClassLoaderSE getClassLoader()
      このフロー定義でクラスをロードするために使用するクラスローダーを返します。
      戻り値:
      クラスローダー

    • getApplicationContext

      org.springframework.context.ApplicationContext getApplicationContext()
      このフロー定義で使用されるアプリケーションオブジェクトとサービスをホストするアプリケーションコンテキストへの参照を返します。
      戻り値:
      アプリケーションコンテキスト

    • inDevelopment

      boolean inDevelopment()
      このフロー定義が現在開発中（開発モードで実行中）の場合は true を返します。
      戻り値:
      開発旗

    • destroy

      void destroy()
      このフロー定義を破棄し、すべてのリソースを解放します。フローが破棄された後は、再度開始することはできません。