12.4.14 freeWI（作業の返却）
構文
boolean freeWI(
java.sql.Connection aDBConnection,
CIWServer aCIWServer,
java.lang.Integer aProcessInstanceID,
java.lang.Integer aWorkItemID
)
throws CIWFatalException,
CIWTransientException,
CIWStateException,
CIWEntityNotExistException,
CIWTransitionFailedException
機能
案件IDと作業IDで指定された作業の状態を「作業者実行」から「実行開始可能」に変更し，作業者をレーン名に戻します。
対象となる作業は，ユーザタスクから変換された作業です。
引数
freeWIの引数を次の表に示します。
|
項番 |
仮引数名 |
名称 |
I/O |
説明 |
|---|---|---|---|---|
|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 |
|
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 |
|
3 |
aProcessInstanceID |
案件ID |
in |
対象である作業の案件IDを指定します。 nullは指定できません。 |
|
4 |
aWorkItemID |
作業ID |
in |
対象である作業の作業IDを指定します。 nullは指定できません。 |
戻り値
作業の返却を実行したかどうかを返します。
true：実行しました
false：作業の返却が実行済みだったので実行しませんでした
作業の返却が実行済みだったかどうかの判定については，「5.3 Java API利用時の注意事項」の「べき等性について」の説明を参照してください。
例外
freeWIで発生する例外を次の表に示します。
|
項番 |
発生する例外 |
説明 |
|---|---|---|
|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
|
2 |
CIWTransientException |
一時的なエラーが発生した場合 |
|
3 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
|
4 |
CIWStateException |
状態の遷移に失敗した場合 |
|
5 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
JDBCコネクションおよびCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
案件IDおよび作業IDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
対象となる作業はユーザタスクから変換された作業だけです。ユーザタスク以外から変換された作業を指定した場合は，例外（CIWStateException）が発生します。
-
指定した条件を満たす作業オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。
-
対象となる作業は，「作業者実行」状態である必要があります。そのほかの場合では，例外（CIWStateException）が発生します。対象となる作業が「実行開始可能」状態かつ作業者がレーン名の場合は，例外は発生しないでfalseが返ります。