メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | add (String processInstanceId , String activityId , Object parameterMap ) オプショナルタスクを追加します。 |
ResultObject | add (String processInstanceId , String activityId , Object parameterMap , Number version ) オプショナルタスクを追加します。 |
void | deleteOptionalTaskInstance (String processInstanceId , String activityId ) 事前追加済のオプショナルタスクを削除します。 |
void | deleteOptionalTaskInstance (String processInstanceId , String activityId , Number version ) 事前追加済のオプショナルタスクを削除します。 |
ResultObject | getAddableOptionalTaskInfo (String processInstanceId ) プロセスインスタンスに追加できるオプショナルタスクの情報を取得します。 |
ResultObject | getOptionalTaskInstance (String processInstanceId , String activityId ) 事前追加済のオプショナルタスクを取得します。 |
ResultObject | getOptionalTaskInstances (String processInstanceId ) プロセスインスタンスに事前追加済のオプショナルタスクを取得します。 |
ResultObject | getVersion (String processInstanceId ) バージョンを取得します。 |
ResultObject | removeParameter (String processInstanceId , String activityId , String variableName ) 事前追加済のオプショナルタスクのパラメータの変数を削除します。 |
ResultObject | removeParameter (String processInstanceId , String activityId , String variableName , Number version ) 事前追加済のオプショナルタスクのパラメータの変数を削除します。 |
ResultObject | removeParameters (String processInstanceId , String activityId , String[] variableNames ) 事前追加済のオプショナルタスクの複数のパラメータの変数を削除します。 |
ResultObject | removeParameters (String processInstanceId , String activityId , String[] variableNames , Number version ) 事前追加済のオプショナルタスクの複数のパラメータの変数を削除します。 |
ResultObject | setParameters (String processInstanceId , String activityId , Object parameterMap ) 事前追加済のオプショナルタスクの複数のパラメータの変数を設定します。 |
ResultObject | setParameters (String processInstanceId , String activityId , Object parameterMap , Number version ) 事前追加済のオプショナルタスクの複数のパラメータの変数を設定します。 |
ResultObject | startProcessInstanceById (String processDefinitionId , String businessKey , Object variables , Array [optionalTaskInstances] ) プロセス定義IDにより、プロセスを開始します。 |
ResultObject | startProcessInstanceByKey (String processDefinitionKey , String businessKey , Object variables , Array [optionalTaskInstances] ) プロセス定義キーにより、プロセスを開始します。 |
メソッドの詳細
ResultObject add (String processInstanceId , String activityId , Object parameterMap )
オプショナルタスクを追加します。
プロセスインスタンスIDと追加するアクティビティIDを指定してください。 parameterMapは、Mapのkeyにパラメータの変数名を設定し、valueに値を設定してください。 指定されたアクティビティのオプショナルタスクが既に追加されている場合、例外が発生します。 ただし、「複数実行可能」なオプショナルタスクの場合、追加され実行中でも再度追加できます。
パラメータ
返却値
|
ResultObject add (String processInstanceId , String activityId , Object parameterMap , Number version )
オプショナルタスクを追加します。
プロセスインスタンスIDと追加するアクティビティIDを指定してください。 parameterMapは、Mapのkeyにパラメータの変数名を設定し、valueに値を設定してください。 バージョンを指定することで、楽観排他制御が行えます。バージョンはプロセスインスタンス単位で割り当てられています。 バージョンは、オプショナルタスクが追加、更新、削除がされた際にインクリメントされます。 ただし、オプショナルタスクの追加時に即実行中になった場合はインクリメントされません。 指定されたアクティビティのオプショナルタスクが既に追加されている場合、例外が発生します。 ただし、「複数実行可能」なオプショナルタスクの場合、追加され実行中でも再度追加できます。
パラメータ
返却値
|
void deleteOptionalTaskInstance (String processInstanceId , String activityId )
事前追加済のオプショナルタスクを削除します。
指定されたアクティビティのオプショナルタスクが存在しない場合、例外が発生します。
パラメータ
返却値
|
void deleteOptionalTaskInstance (String processInstanceId , String activityId , Number version )
事前追加済のオプショナルタスクを削除します。
指定されたアクティビティのオプショナルタスクが存在しない場合、例外が発生します。 バージョンを指定することで、楽観排他制御が行えます。バージョンはプロセスインスタンス単位で割り当てられています。 バージョンは、オプショナルタスクが追加、更新、削除がされた際にインクリメントされます。 ただし、オプショナルタスクの追加時に即実行中になった場合はインクリメントされません。
パラメータ
返却値
|
ResultObject getAddableOptionalTaskInfo (String processInstanceId )
プロセスインスタンスに追加できるオプショナルタスクの情報を取得します。
パラメータ
返却値
|
ResultObject getOptionalTaskInstance (String processInstanceId , String activityId )
事前追加済のオプショナルタスクを取得します。
存在しない場合、nullを返却します。
パラメータ
返却値
|
ResultObject getOptionalTaskInstances (String processInstanceId )
プロセスインスタンスに事前追加済のオプショナルタスクを取得します。
パラメータ
返却値
|
ResultObject getVersion (String processInstanceId )
バージョンを取得します。
パラメータ
返却値
|
ResultObject removeParameter (String processInstanceId , String activityId , String variableName )
事前追加済のオプショナルタスクのパラメータの変数を削除します。
パラメータ
返却値
|
ResultObject removeParameter (String processInstanceId , String activityId , String variableName , Number version )
事前追加済のオプショナルタスクのパラメータの変数を削除します。
バージョンを指定することで、楽観排他制御が行えます。バージョンはプロセスインスタンス単位で割り当てられています。 バージョンは、オプショナルタスクが追加、更新、削除がされた際にインクリメントされます。 ただし、オプショナルタスクの追加時に即実行中になった場合はインクリメントされません。
パラメータ
返却値
|
ResultObject removeParameters (String processInstanceId , String activityId , String[] variableNames )
事前追加済のオプショナルタスクの複数のパラメータの変数を削除します。
パラメータ
返却値
|
ResultObject removeParameters (String processInstanceId , String activityId , String[] variableNames , Number version )
事前追加済のオプショナルタスクの複数のパラメータの変数を削除します。
バージョンを指定することで、楽観排他制御が行えます。バージョンはプロセスインスタンス単位で割り当てられています。 バージョンは、オプショナルタスクが追加、更新、削除がされた際にインクリメントされます。 ただし、オプショナルタスクの追加時に即実行中になった場合はインクリメントされません。
パラメータ
返却値
|
ResultObject setParameters (String processInstanceId , String activityId , Object parameterMap )
事前追加済のオプショナルタスクの複数のパラメータの変数を設定します。
パラメータマップに設定されているすべてのパラメータを上書きします。
パラメータ
返却値
|
ResultObject setParameters (String processInstanceId , String activityId , Object parameterMap , Number version )
事前追加済のオプショナルタスクの複数のパラメータの変数を設定します。
パラメータマップに設定されているすべてのパラメータを上書きします。 バージョンを指定することで、楽観排他制御が行えます。バージョンはプロセスインスタンス単位で割り当てられています。 バージョンは、オプショナルタスクが追加、更新、削除がされた際にインクリメントされます。 ただし、オプショナルタスクの追加時に即実行中になった場合はインクリメントされません。
パラメータ
返却値
|
ResultObject startProcessInstanceById (String processDefinitionId , String businessKey , Object variables , Array [optionalTaskInstances] )
プロセス定義IDにより、プロセスを開始します。
業務キーと変数を設定します。 プロセス開始時に指定したオプショナルタスクを追加します。
パラメータ
返却値
|
ResultObject startProcessInstanceByKey (String processDefinitionKey , String businessKey , Object variables , Array [optionalTaskInstances] )
プロセス定義キーにより、プロセスを開始します。
業務キーと変数を設定します。 プロセス開始時に指定したオプショナルタスクを追加します。
パラメータ
返却値
|