12.4.8 completeWI(作業の完了)
構文
boolean completeWI( java.sql.Connection aDBConnection, CIWServer aCIWServer, java.lang.Integer aProcessInstanceID, java.lang.Integer aWorkItemID, java.util.Collection<CIWBPMNProcessData<?>> aProcessDataCollection ) throws CIWFatalException, CIWTransientException, CIWTransitionFailedException, CIWStateException, CIWEntityNotExistException
機能
案件IDと作業IDで指定された作業を完了します。また,指定されたプロセスデータを更新します。
対象となる作業は,ユーザタスクから変換された作業です。
引数
completeWIの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
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は指定できません。 |
5 |
aProcessDataCollection |
プロセスデータのコレクション |
in |
プロセスデータを更新しない場合はnullを指定します。 |
戻り値
作業の完了を実行したかどうかを返します。
true:実行しました
false:作業の完了が実行済みだったので実行しませんでした
例外
completeWIで発生する例外を次の表に示します。
項番 |
発生する例外 |
説明 |
---|---|---|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
2 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
3 |
CIWTransientException |
一時的なエラーが発生した場合 |
4 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
5 |
CIWStateException |
状態の遷移に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
JDBCコネクションとCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
案件IDまたは作業IDにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
対象となる作業はユーザタスクから変換された作業である必要があります。ユーザタスク以外から変換された作業を指定した場合は,例外(CIWStateException)が発生します。
-
指定した条件を満たす業務ステップオブジェクトが存在しない場合は,例外(CIWEntityNotExistException)が発生します。
-
対象となる作業は,「実行中」状態である必要があります。そのほかの場合は,例外(CIWStateException)が発生します。ただし,対象となる作業が「実行済」状態の場合は,例外は発生しないでfalseが返されます。