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