12.4.2 deletePI（案件の削除）
構文
boolean deletePI(
java.sql.Connection aDBConnection,
CIWServer aCIWServer,
java.lang.Integer aProcessInstanceID
)
throws CIWFatalException,
CIWTransientException,
CIWStateException
機能
案件IDで指定された案件を削除します。削除する案件のプロセスデータも削除します。
ルート案件だけを指定できます。子案件がある場合は，子案件（子案件の子案件も含む）もすべて削除します。
引数
deletePIの引数を次の表に示します。
|
項番 |
仮引数名 |
名称 |
I/O |
説明 |
|---|---|---|---|---|
|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 nullは指定できません。 |
|
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 nullは指定できません。 |
|
3 |
aProcessInstanceID |
案件ID |
in |
削除する案件のIDを指定します。 nullは指定できません。 |
戻り値
案件の削除を実行したかどうかを返します。
true：実行しました
false：案件が削除済みだったので実行しませんでした
例外
deletePIで発生する例外を次の表に示します。
|
項番 |
発生する例外 |
説明 |
|---|---|---|
|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
|
2 |
CIWTransientException |
一時的なエラーが発生した場合 |
|
3 |
CIWStateException |
状態や属性の変更に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
JDBCコネクションとCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
案件IDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
指定した条件を満たす案件オブジェクトが存在しない場合は，falseを返します。
-
案件が「終了」状態の場合だけ案件を削除できます。そのほかの状態の場合は，例外（CIWStateException）が発生します。
-
ルート案件だけを指定できます。ルート案件以外を指定した場合は，例外（CIWStateException）が発生します。