createProcessInstance

インタフェース名：CIWServer

〈このページの構成〉

構文
機能
引数
戻り値
例外
注意事項

構文

CIWProcessInstance createProcessInstance(
     java.util.Map
     <CIWProcessInstance.AttributeName,java.lang.Object> aAttributes,
     java.lang.String aProcessDefinitionName,
     java.lang.Short aVersion
)
     throws CIWFatalException,
            CIWTransientException,
            CIWEntityNotExistException

ページの先頭へ

機能

案件属性，ビジネスプロセス定義の名称およびバージョンを指定して，案件を生成します。

ページの先頭へ

引数

createProcessInstanceの引数を次の表に示します。

表5‒91　createProcessInstanceの引数
仮引数名	名称	in/out	説明
aAttributes	案件属性のマップ	in	案件属性（案件属性名と属性値の組）のマップを指定します。指定できる属性を次に示します。案件名（Name）処理期限（Deadline）優先度（Priority）案件属性を指定しない場合は，nullまたはサイズ0の案件属性のマップを指定します。各案件属性名の属性値は次に示す型で指定します。案件名：java.lang.String型処理期限：java.util.Date型優先度：java.lang.Integer型属性値にnullを指定した場合は，指定した案件属性は未設定になります。案件名の値は，空文字は指定できません。処理期限の絶対日時として指定できる値は，CIWUtil#convertDateToString(Date)で指定できるDate値と同じです。ただし，ミリ秒以下については切り捨てられます。
aProcessDefinitionName	ビジネスプロセス定義の名称	in	ビジネスプロセス定義の名称を指定します。空文字列またはnullは指定できません。
aVersion	ビジネスプロセス定義のバージョン	in	ビジネスプロセス定義のバージョンを指定します。 nullを指定した場合，指定したビジネスプロセス定義の中で最新バージョンとなります。

ページの先頭へ

戻り値

生成した案件オブジェクトを返します。

ページの先頭へ

例外

createProcessInstanceで発生する例外を次の表に示します。

表5‒92　createProcessInstanceで発生する例外
発生する例外	説明
CIWFatalException	処理を続行できない障害が発生した場合
CIWTransientException	一時的なエラーが発生した場合
CIWEntityNotExistException	処理しようとしたオブジェクトが存在しない場合

ページの先頭へ

注意事項

ビジネスプロセス定義の処理期限ルールを定義している場合は，処理期限を未設定にしてもビジネスプロセス定義の処理期限ルールに従って値が設定されます。値は案件開始時に案件の開始日時（START_DATE）を起算日として算出されます。
案件名の値に空文字を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
指定された属性名と属性値の型が一致しない場合は，例外（java.lang.IllegalArgumentException）が発生します。
ビジネスプロセス定義の名称に空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
存在しないビジネスプロセス定義のバージョンを指定した場合は，例外（CIWEntityNotExistException）が発生します。

ページの先頭へ