changeState

インタフェース名：CIWWorkItem

〈このページの構成〉

構文
機能
引数
戻り値
例外
注意事項

構文

void changeState(
     CIWWorkItem.State aNewState
)
     throws CIWTransientException,
            CIWTransitionFailedException,
            CIWFatalException,
            CIWEntityNotExistException,
            CIWStateException

ページの先頭へ

機能

対象となる作業の状態を変更します。

ページの先頭へ

引数

changeStateの引数を次の表に示します。

表5‒131　changeStateの引数（CIWWorkItemの場合）
仮引数名	名称	in/out	説明
aNewState	状態	in	変更する作業の状態を指定します。指定する値には，このインタフェースに定義されたCIWWorkItem.State列挙型の定数を指定できます。nullは指定できません。

aNewStateで指定できる作業の状態を次の表に示します。

表5‒132　aNewStateで指定できる作業の状態（CIWWorkItemの場合）
現在の状態		指定できる状態		状態遷移の意味	N	B
定数	意味	定数	意味	状態遷移の意味	N	B
INITIAL	初期	READY	実行開始可能	準備済	○	○
READY	実行開始可能	PERFORMING	作業者実行	着手	○	×
PERFORMING	作業者実行	READY	実行開始可能	返却^※1	○	×
PERFORMING	作業者実行	EXECUTED	実行済	完了通知	○	×
EXECUTING	自動実行	EXECUTED	実行済	作業完了	×	○
RUNNING	実行中	INTERMITTED	実行停止	中断	○	○
INTERMITTED	実行停止	RUNNING	実行中^※2	再開^※3	○	○
−	未終了	TERMINATED	強制終了	強制終了	○	○

（凡例）

N：一般作業に対する指定の可否

B：組み込み作業（並列作業）に対する指定の可否

定数：CIWWorkItem.State列挙型の定数

○：指定できることを示します。

×：指定できないことを示します。

−：定数がないことを表します。

注※1

アプリケーション自動起動を返却した場合は，アプリケーションを再起動します。

注※2

状態には，「実行中」，それに含まれる「自動実行」および「作業者実行」を指定できます。

注※3

指定できる状態のどれかを指定した場合は，次に示す状態に遷移します。

一般作業の場合：「作業者実行」
組み込み作業の場合：「自動実行」

状態遷移については，「付録C　状態遷移モデル」を参照してください。

ページの先頭へ

戻り値

ありません。

ページの先頭へ

例外

changeStateで発生する例外を次の表に示します。

表5‒133　changeStateで発生する例外（CIWWorkItemの場合）
発生する例外	説明
CIWTransientException	一時的なエラーが発生した場合
CIWTransitionFailedException	案件処理中にエラーが発生した場合
CIWFatalException	処理を続行できない障害が発生した場合
CIWEntityNotExistException	処理しようとしたオブジェクトが存在しない場合
CIWStateException	状態の遷移に失敗した場合

ページの先頭へ

注意事項

対象となる作業が属する案件がエラー案件の場合は，例外（CIWStateException）が発生します。
エラー回復作業で本メソッドを呼び出した場合は，例外（CIWStateException）が発生します。
変更する作業状態にnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
作業を強制終了した場合は，対象となる作業が所属する業務ステップの完了条件の評価は行いません。そのため，対象となる作業が所属する業務ステップを直接完了させるか，またはCIWActivityInstance#evaluate()を使用して業務ステップの完了条件の評価を実行し，業務ステップの完了または作業の再作成を行う必要があります。CIWActivityInstance#evaluate()を使用して評価を実行する場合は，作業の発生条件や完了条件が適切に定義されている必要があります。

ページの先頭へ