概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| Nautica Workflow
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.co.argo21.nautica.workflow.omg
インタフェース WfExecutionObject

すべてのスーパーインタフェース:
  java.io.Serializable, WfObject

既知のサブインタフェースの一覧:
  WfActivity, WfProcess

既知の実装クラスの一覧:
  ActivityInternal

public interface WfExecutionObject
extends WfObject

WfExecutionObjectは、WfProcessとWfActivityの共通の属性や状態、 操作を定義する管理実体の基底インタフェースである。 本書では、この管理実体を「実行オブジェクト」と表記する。 WfExecutionObjectは、内部状態の取得および設定機能を提供する。 現時点での状態を取得する操作、別の状態に遷移させる操作、 ある特定の状態遷移に対する操作が提供されている。 これらの操作は保留(suspend)、再開(resume)、停止(terminate)、中断(abort)である。 インタフェースには、名前、説明、キーとなる属性を含む。 また、実行履歴を表す監査情報を、指定されたフィルタに基づいて返すことによって、 WfExecutionObjectの実行の監視操作も提供する。 他にも、コンテキストの取得と設定のメソッドがある。

導入されたバージョン:
  Nautica Workflow 0.9
バージョン:
  $Revision: 1.2 $

メソッドの概要
`void` | `abort()` 保留された実行オブジェクトの中断を要求する。
`void` | `changeState(WfState state)` 指定された状態に遷移を試みる。
`WfEvent[]` | `getAllHistories()` この実行オブジェクトに関わる変更履歴を取得する。
`WfNameValue[]` | `getContext()` 実行オブジェクトにかかわる属性一覧を返す。
`WfNameValue` | `getContext(java.lang.String name)` 実行オブジェクトにかかわる属性を返す。
`java.lang.String` | `getDescription()` 詳細情報を返す。
`WfEvent` | `getHistory(int index)` インデクスを指定して、履歴を取得する。
`int` | `getHistoryCount()` 変更履歴の数を返す。
`java.lang.String` | `getID()` IDを返す。
`java.lang.String` | `getLastStateTime()` 最後に状態が遷移した時間を返す。
`java.lang.String` | `getName()` 名称を返す。
`WfState` | `getState()` 現在の状態を返す。
`WfState[]` | `getTransitableStates()` 現在の状態から遷移可能な状態の一覧を返す。
`void` | `resume()` 保留中の実行オブジェクトの再開を要求する。
`void` | `setContext(WfNameValue context)` 実行オブジェクトにかかわる属性を設定する。
`void` | `setContext(WfNameValue[] context)` 実行オブジェクトにかかわる属性一覧を設定する。
`void` | `setDescription(java.lang.String desc)` 詳細情報を設定する。
`void` | `setName(java.lang.String name)` 名称を設定する。
`void` | `suspend()` 実行オブジェクトの保留を要求する。
`void` | `terminate()` 実行中の実行オブジェクトの停止を要求する。

メソッドの詳細

### getID

    public java.lang.String getID()
                           throws WorkflowException

  IDを返す。

  戻り値:
    ID
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getName

    public java.lang.String getName()
                             throws WorkflowException

  名称を返す。

  戻り値:
    名称
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### setName

    public void setName(java.lang.String name)
                 throws WorkflowException

  名称を設定する。

  パラメータ:
    `name` - 名称
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getDescription

    public java.lang.String getDescription()
                                    throws WorkflowException

  詳細情報を返す。

  戻り値:
    詳細情報
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### setDescription

    public void setDescription(java.lang.String desc)
                        throws WorkflowException

  詳細情報を設定する。

  パラメータ:
    `desc` - 詳細情報
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getState

    public WfState getState()
                     throws WorkflowException

  現在の状態を返す。

  戻り値:
    状態
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getTransitableStates

    public WfState[] getTransitableStates()
                                   throws WorkflowException

  現在の状態から遷移可能な状態の一覧を返す。

  戻り値:
    遷移可能な状態の一覧
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### changeState

    public void changeState(WfState state)
                     throws InvalidStateException,
                            TransitionNotAllowedException,
                            WorkflowException

  指定された状態に遷移を試みる。

  パラメータ:
    `state` - 状態
  例外:
    `InvalidStateException` - 無効な状態の場合
    `TransitionNotAllowedException` - 指定された状態に遷移できない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getLastStateTime

    public java.lang.String getLastStateTime()
                                      throws WorkflowException

  最後に状態が遷移した時間を返す。

  戻り値:
    最終状態変更時間
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### resume

    public void resume()
                throws CannotResumeException,
                       NotRunningException,
                       NotSuspendedException,
                       WorkflowException

  保留中の実行オブジェクトの再開を要求する。 要求が受け入れられた場合、状態は、open.not_running.suspendedから、 open.runningに設定される。

  例外:
    `CannotResumeException` - 再開できない場合
    `NotRunningException` - 走行中でない場合
    `NotSuspendedException` - 保留されていない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### suspend

    public void suspend()
                 throws CannotSuspendException,
                        NotRunningException,
                        AlreadySuspendedException,
                        WorkflowException

  実行オブジェクトの保留を要求する。 要求が受け入れられた場合、状態は、open.not_running.suspendedに設定される。

  例外:
    `CannotSuspendException` - 保留できない場合
    `NotRunningException` - 走行中でない場合
    `AlreadySuspendedException` - すでに保留されている場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### terminate

    public void terminate()
                   throws CannotStopException,
                          NotRunningException,
                          WorkflowException

  実行中の実行オブジェクトの停止を要求する。 要求が受け入れられた場合、状態はclosed.terminatedに設定される。

  例外:
    `CannotStopException` - 停止できない場合
    `NotRunningException` - 走行中でない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### abort

    public void abort()
               throws CannotStopException,
                      NotRunningException,
                      WorkflowException

  保留された実行オブジェクトの中断を要求する。 要求が受け入れられた場合、状態はclosed.abortedに設定される。

  例外:
    `CannotStopException` - 停止できない場合
    `NotRunningException` - 走行中でない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getContext

    public WfNameValue[] getContext()
                             throws WorkflowException

  実行オブジェクトにかかわる属性一覧を返す。

  戻り値:
    属性一覧
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getContext

    public WfNameValue getContext(java.lang.String name)
                           throws WorkflowException

  実行オブジェクトにかかわる属性を返す。

  パラメータ:
    `name` - 属性名
  戻り値:
    属性
  例外:
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### setContext

    public void setContext(WfNameValue[] context)
                    throws InvalidDataException,
                           UpdateNotAllowedException,
                           WorkflowException

  実行オブジェクトにかかわる属性一覧を設定する。

  パラメータ:
    `context` - 属性一覧
  例外:
    `InvalidDataException` - 無効な属性の場合
    `UpdateNotAllowedException` - 更新ができない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### setContext

    public void setContext(WfNameValue context)
                    throws InvalidDataException,
                           UpdateNotAllowedException,
                           WorkflowException

  実行オブジェクトにかかわる属性を設定する。

  パラメータ:
    `context` - 属性
  例外:
    `InvalidDataException` - 無効な属性の場合
    `UpdateNotAllowedException` - 更新ができない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getHistoryCount

    public int getHistoryCount()
                        throws HistoryNotAvailableException,
                               WorkflowException

  変更履歴の数を返す。

  戻り値:
    変更履歴の数
  例外:
    `HistoryNotAvailableException` - 変更履歴が取得可能でない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getHistory

    public WfEvent getHistory(int index)
                       throws HistoryNotAvailableException,
                              WorkflowException

  インデクスを指定して、履歴を取得する。

  パラメータ:
    `index` - インデクス
  戻り値:
    変更履歴
  例外:
    `HistoryNotAvailableException` - 変更履歴が取得可能でない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

### getAllHistories

    public WfEvent[] getAllHistories()
                              throws HistoryNotAvailableException,
                                     WorkflowException

  この実行オブジェクトに関わる変更履歴を取得する。

  戻り値:
    変更履歴
  例外:
    `HistoryNotAvailableException` - 変更履歴が取得可能でない場合
    `WorkflowException` - ワークフロー関連で例外が発生した場合

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| 株式会社アルゴ２１
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright 2005 株式会社アルゴ２１