IM-BPM スクリプト開発API

bpm.OptionalTaskServiceオブジェクト

コンポーネント情報
version8.0.11
since8.0.9
コンポーネント概要
オプショナルタスクに対する操作を行うクラスです。

メソッドの概要

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

Copyright © 2016 NTT DATA INTRAMART CORPORATION