12.4.16 sendMessage（メッセージイベント送信）
構文
boolean sendMessage (
java.sql.Connection aDBConnection,
CIWServer aCIWServer,
java.lang.Integer aProcessInstanceID,
java.util.Collection<CIWBPMNProcessData<?>> aProcessDataCollection,
String aMessageRef
)
throws CIWFatalException,
CIWTransitionFailedException,
CIWTransientException,
CIWEntityNotExistException,
CIWStateException
機能
案件IDで指定された案件に対して指定されたmessageRefのキャッチ処理を行います。指定されたmessageRefの受信待ちのイベントが複数ある場合はすべて処理します。指定されたプロセスデータを更新します。
引数
sendMessageの引数を次の表に示します。
|
項番 |
仮引数名 |
名称 |
I/O |
説明 |
|---|---|---|---|---|
|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 nullは指定できません。 |
|
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 nullは指定できません。 |
|
3 |
aProcessInstanceID |
案件ID |
in |
メッセージを受信する案件のIDを指定します。 nullは指定できません。 |
|
4 |
aProcessDataCollection |
プロセスデータのコレクション |
in |
プロセスデータを更新しない場合はnullを指定します。 |
|
5 |
aMessageRef |
messageRef |
in |
メッセージを受信するイベントのmessageRefを指定します。 空文字列およびnullは指定できません。 |
戻り値
キャッチを実行したかどうかを返します。
true：実行しました
false：指定した案件にキャッチ待ちが存在しなかったので実行しませんでした
例外
sendMessageで発生する例外を次の表に示します。
|
項番 |
発生する例外 |
説明 |
|---|---|---|
|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
|
2 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
|
3 |
CIWTransientException |
一時的なエラーが発生した場合 |
|
4 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
|
5 |
CIWStateException |
状態や属性の変更に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
JDBCコネクションとCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
messageRefに空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
案件IDにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
指定した条件を満たす案件オブジェクトが存在しない場合は，例外（CIWEntityNotExistException）が発生します。
-
指定された案件が「実行中」状態ではない場合は，例外（CIWStateException）が発生します。