12.4.17 startMessage(案件投入(メッセージ))
構文
CIWProcessInstance startMessage( java.sql.Connection aDBConnection, CIWServer aCIWServer, java.lang.String aProcessDefinitionName, java.lang.Short aProcessDefinitionVersion, java.util.Map<CIWProcessInstance.AttributeName,java.lang.Object> aAttributes, java.util.Collection<CIWBPMNProcessData<?>> aProcessDataCollection, java.lang.String aMessageRef ) throws CIWFatalException, CIWTransitionFailedException, CIWTransientException, CIWEntityNotExistException, CIWStateException
機能
指定されたビジネスプロセス定義名とビジネスプロセス定義バージョンに対応するビジネスプロセス定義で,messageRefを指定して案件を生成し開始します。プロセスデータに親案件の案件IDを登録します。指定されたプロセスデータは,生成した案件の案件IDを指定して登録します。
指定されたmessageRefの開始(メッセージ)が定義されているビジネスプロセス定義しか案件投入できません。
引数
startMessageの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
I/O |
説明 |
---|---|---|---|---|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 nullは指定できません。 |
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 nullは指定できません。 |
3 |
aProcessDefinitionName |
ビジネスプロセス定義名 |
in |
ビジネスプロセス定義名を指定します。 空文字列およびnullは指定できません。 |
4 |
aProcessDefinitionVersion |
ビジネスプロセス定義バージョン |
in |
ビジネスプロセス定義バージョンを指定します。nullを指定した場合,指定したビジネスプロセス定義の中で投入可能(状態が活性かつ案件投入期間内)な最新バージョンになります。 |
5 |
aAttributes |
案件属性のマップ |
in |
案件属性のマップを指定します。詳細はCIWServerインタフェースのcreateAndStartProcessInstance メソッドを参照。 |
6 |
aProcessDataCollection |
プロセスデータのコレクション |
in |
プロセスデータを追加しない場合はnullを指定します。 |
7 |
aMessageRef |
messageRef |
in |
案件投入する開始(メッセージ)のmessageRefを指定します。 空文字列およびnullは指定できません。 |
戻り値
開始した案件オブジェクトを返します。
例外
startMessageで発生する例外を次の表に示します。
項番 |
発生する例外 |
説明 |
---|---|---|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
2 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
3 |
CIWTransientException |
一時的なエラーが発生した場合 |
4 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
5 |
CIWStateException |
状態や属性の変更に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
JDBCコネクションとCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
指定されたビジネスプロセス定義が存在しない場合や案件投入できない場合(状態が非活性または案件投入期間外の場合),例外(CIWEntityNotExistException)が発生します。
-
ビジネスプロセス定義バージョンにnullが指定された場合,指定されたビジネスプロセス定義の案件投入可能(状態が活性かつ案件投入期間内)な最新バージョンのビジネスプロセス定義で案件投入します。案件投入するビジネスプロセス定義に,指定されたmessageRefの開始(メッセージ)が定義されていない場合,例外(CIWEntityNotExistException)が発生します。
-
messageRefに空文字列またはnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
案件名の値に空文字列を指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
指定された属性名と属性値の型が一致しない場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
ビジネスプロセス定義の名称に空文字列またはnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。