12.4.15 setProcessData(プロセスデータの登録)
構文
void setProcessData( java.sql.Connection aDBConnection, java.lang.Integer aProcessInstanceID, java.util.Collection<CIWBPMNProcessData<?>> aProcessDataCollection ) throws CIWFatalException, CIWTransientException, CIWEntityNotExistException
機能
案件IDで指定された案件に,プロセスデータを登録します。プロセスデータキー名がすでに存在している場合は,指定されたプロセスデータ値で更新します。なお,プロセスデータテーブルのProcessDataNameカラム値は次の形式で登録します。
-
プロセスデータキー名の先頭の$Nまたは$Sが削除される
-
リスト型プロセスデータを登録する場合,プロセスデータキー名の末尾の"{}"内に,先頭のデータから順番にリスト内識別子(番号)が付与される
引数
setProcessDataの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
I/O |
説明 |
---|---|---|---|---|
1 |
aDBConnection |
JDBCコネクション |
in |
JDBCコネクションを指定します。 nullは指定できません。 |
2 |
aProcessInstanceID |
案件ID |
in |
プロセスデータを登録する案件の案件IDを指定します。 nullは指定できません。 |
3 |
aProcessDataCollection |
プロセスデータのコレクション |
in |
複数件のプロセスデータを持つプロセスデータのコレクションを指定します。 |
戻り値
なし
例外
setProcessDataで発生する例外を次の表に示します。
項番 |
発生する例外 |
説明 |
---|---|---|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
2 |
CIWTransientException |
一時的なエラーが発生した場合 |
3 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
注意事項
-
JDBCコネクションにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
案件IDにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
プロセスデータのコレクションにnullまたは空のコレクションを指定した場合は,プロセスデータを登録しません。
-
プロセスデータのコレクションに重複したプロセスデータキー名のプロセスデータを指定した場合,例外(java.lang.IllegalArgumentException)が発生します。
-
指定した案件が存在する場合,案件の状態に関係なく,プロセスデータを登録または更新します。
-
指定した案件が存在しない場合は,例外(CIWEntityNotExistException)が発生します。