12.4.18 createAndStartPIForTimer(案件投入(タイマー))
構文
CIWProcessInstance createAndStartPIForTimer ( java.sql.Connection aDBConnection, CIWServer aCIWServer, java.lang.String aProcessDefinitionName, java.lang.Short aProcessDefinitionVersion, java.lang.String aWorkDefName ) throws CIWFatalException, CIWTransitionFailedException, CIWTransientException, CIWEntityNotExistException, CIWStateException
機能
ビジネスプロセス定義に定義された作業定義名を指定して,開始(タイマー)から案件を生成して開始します。対象となるビジネスプロセス定義は,ビジネスプロセス定義名,およびビジネスプロセス定義バージョンで指定します。
案件投入できるのは,指定された作業定義名の開始(タイマー)が定義されているビジネスプロセス定義だけです。
このAPIで案件を投入しても,次回の案件投入時刻や案件投入回数には影響ありません。
引数
createAndStartPIForTimerの引数を次の表に示します。
項番 |
仮引数名 |
名称 |
I/O |
説明 |
---|---|---|---|---|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 nullは指定できません。 |
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 nullは指定できません。 |
3 |
aProcessDefinitionName |
ビジネスプロセス定義名 |
in |
ビジネスプロセス定義名を指定します。 空文字列およびnullは指定できません。 |
4 |
aProcessDefinitionVersion |
ビジネスプロセス定義バージョン |
in |
ビジネスプロセス定義バージョンを指定します。nullを指定した場合,指定したビジネスプロセス定義の中で投入可能(状態が活性かつ案件投入期間内)な最新バージョンになります。 |
5 |
aWorkDefName |
作業定義名 |
in |
案件投入する開始(タイマー)の作業定義名を指定します。 空文字列およびnullは指定できません。 |
戻り値
開始した案件オブジェクトを返します。
例外
createAndStartPIForTimerで発生する例外を次の表に示します。
項番 |
発生する例外 |
説明 |
---|---|---|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
2 |
CIWTransitionFailedException |
案件処理中にエラーが発生した場合 |
3 |
CIWTransientException |
一時的なエラーが発生した場合 |
4 |
CIWEntityNotExistException |
処理しようとしたオブジェクトが存在しない場合 |
5 |
CIWStateException |
状態や属性の変更に失敗した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
JDBCコネクションおよびCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
指定されたビジネスプロセス定義が存在しない場合や案件投入可能(状態が活性かつ案件投入期間内)でない場合,例外(CIWEntityNotExistException)が発生します。
-
ビジネスプロセス定義バージョンにnullが指定された場合,指定されたビジネスプロセス定義の案件投入可能(状態が活性かつ案件投入期間内)な最新バージョンで案件投入します。案件投入するビジネスプロセス定義に,指定された作業定義名の開始(タイマー)が定義されていない場合,例外(CIWEntityNotExistException)が発生します。
-
作業定義名に空文字列またはnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
案件名は,「<ビジネスプロセス定義名>_<バージョン(前ゼロ4桁)>_<yyyymmddHHMMss形式の時刻>」になります。
-
ビジネスプロセス定義名に空文字列またはnullを指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。