12.4.1 createAndStartPI(案件投入)
構文
CIWProcessInstance createAndStartPI( 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 ) throws CIWFatalException, CIWTransitionFailedException, CIWTransientException, CIWEntityNotExistException, CIWStateException
機能
指定されたビジネスプロセス定義名とビジネスプロセス定義バージョンのビジネスプロセス定義で案件を生成し開始します。指定されたプロセスデータは,生成した案件の案件IDを指定して登録します。
開始(タイプなし)が定義されているビジネスプロセス定義だけ,案件投入できます。
引数
createAndStartPIの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
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を指定します。 |
戻り値
開始した案件オブジェクトを返します。
例外
createAndStartPIで発生する例外を次の表に示します。
項番 |
発生する例外 |
説明 |
---|---|---|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
2 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
3 |
CIWTransientException |
一時的なエラーが発生した場合 |
4 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
5 |
CIWStateException |
状態や属性の変更に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
JDBCコネクションとCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
指定されたビジネスプロセス定義が存在しない場合や案件を投入できない場合(状態が非活性または案件投入期間外の場合),例外(CIWEntityNotExistException)が発生します。
-
ビジネスプロセス定義バージョンにnullを指定した場合で,指定したビジネスプロセス定義に案件投入可能(状態が活性かつ案件投入期間内)なバージョンが存在しないときは,例外(CIWEntityNotExistException)が発生します。
-
開始(タイプなし)(省略されている場合も含む)が定義されていないビジネスプロセス定義を指定した場合,例外(CIWFatalException)(メッセージKDIW01834-E)が発生します。
-
案件名の値に空文字列を指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
指定された属性名と属性値の型が一致しない場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
ビジネスプロセス定義名に空文字列またはnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。