RouteDataManager オブジェクト

ルート定義情報を管理するマネージャです。

ルート定義情報およびルートXMLファイルの登録、更新、削除、取得を行います。

 管理するルートXMLファイルは以下の2つが存在します。
 1. 標準用のルートのXMLファイル
   [%Storage Service%]
      /workflow
          /data
              /[%ログイングループID%]
                  /[%ログイングループ単位の設定値(master-file-dir)%]
                      /route
                          /[%ルートID%]
                              /[%ルートバージョンID%]
                                  /route.xml
 
 2. テンプレート置換用のルートのXMLファイル
   [%Storage Service%]
      /workflow
          /data
              /[%ログイングループID%]
                  /[%ログイングループ単位の設定値(master-file-dir)%]
                      /route_template
                          /[%ルートID%]
                              /route_template.xml
 
導入されたバージョン:7.2

コンストラクタの概要
RouteDataManager (String loginGroupId)
コンストラクタ
引数で指定したログイングループIDでルート定義情報管理マネージャを新しく生成します。

メソッドの概要
WorkflowResultInfo createRouteData (Array models)
ルート情報を新規作成します。
WorkflowResultInfo createRouteDataFamily (Array models)
ルート情報と配下の情報を新規作成します。
WorkflowResultInfo createRouteDataWithAdjust (Array models)
ルート情報と配下の情報を自動調整し新規作成します。
WorkflowResultInfo createRouteDetailData (Array models)
ルート詳細情報を新規作成します。
WorkflowResultInfo createRouteDetailDataFamily (Array models)
ルート詳細情報と配下の情報を新規作成します。
WorkflowResultInfo createRouteDetailDataWithAdjust (Array models)
ルート詳細情報と配下の情報を自動調整し新規作成します。
WorkflowResultInfo createRoutePluginData (Array models)
ルートユーザ設定情報を新規作成します。
WorkflowResultInfo deleteRouteData (Array models)
ルート情報を削除します。
WorkflowResultInfo deleteRouteDataFamily (Array models)
ルート情報と配下の情報を削除します。
WorkflowResultInfo deleteRouteDetailData (Array models)
ルート詳細情報を削除します。
WorkflowResultInfo deleteRouteDetailDataFamily (Array models)
ルート詳細情報と配下の情報を削除します。
WorkflowResultInfo deleteRouteDetailDataWithAdjust (Array models)
ルート詳細情報と配下の情報を自動調整し削除します。
WorkflowResultInfo deleteRoutePluginData (Array models)
ルートユーザ設定情報を削除します。
WorkflowResultInfo getRouteData (String routeId)
ルート情報を全ロケール分取得します。
WorkflowResultInfo getRouteDataCount (String routeId)
ルート情報の全ロケール分の件数を取得します。
WorkflowResultInfo getRouteDataCountWithLocale (String routeId ,String localeId)
指定したロケールIDでルート情報の件数を取得します。
WorkflowResultInfo getRouteDataFamily (String routeId)
ルート情報と配下の情報を全ロケール分取得します。
WorkflowResultInfo getRouteDataFamilyWithLocale (String routeId ,String localeId)
指定したロケールIDでルート情報と配下の情報を1件取得します。
WorkflowResultInfo getRouteDataList (RouteDataSearchConditionInfo condition)
指定した検索条件でルート情報を検索します。
WorkflowResultInfo getRouteDataListCount (RouteDataSearchConditionInfo condition)
指定した検索条件でルート情報の検索結果件数を取得します。
WorkflowResultInfo getRouteDataListCountWithAccessRole (RouteDataSearchConditionInfo condition ,Array accessRoles)
指定した検索条件とアクセスロールでルート情報の検索結果件数を取得します。
WorkflowResultInfo getRouteDataListWithAccessRole (RouteDataSearchConditionInfo condition ,Array accessRoles)
指定した検索条件とアクセスロールでルート情報を検索します。
WorkflowResultInfo getRouteDataWithLocale (String routeId ,String localeId)
指定したロケールIDでルート情報を1件取得します。
WorkflowResultInfo getRouteDetailData (String routeId ,String routeVersionId)
ルート詳細情報を全ロケール分取得します。
WorkflowResultInfo getRouteDetailDataCount (String routeId ,String routeVersionId)
ルート詳細情報の全ロケール分の件数を取得します。
WorkflowResultInfo getRouteDetailDataCountWithLocale (String routeId ,String routeVersionId ,String localeId)
指定したロケールIDでルート詳細情報の件数を取得します。
WorkflowResultInfo getRouteDetailDataFamily (String routeId ,String routeVersionId)
ルート詳細情報と配下の情報を全ロケール分取得します。
WorkflowResultInfo getRouteDetailDataFamilyWithLocale (String routeId ,String routeVersionId ,String localeId)
指定したロケールIDでルート詳細情報と配下の情報を1件取得します。
WorkflowResultInfo getRouteDetailDataList (String routeId ,RouteDataSearchConditionInfo condition)
指定した検索条件でルート詳細情報を検索します。
WorkflowResultInfo getRouteDetailDataListCount (String routeId ,RouteDataSearchConditionInfo condition)
指定した検索条件でルート詳細情報の検索結果件数を取得します。
WorkflowResultInfo getRouteDetailDataListCountWithAccessRole (String routeId ,RouteDataSearchConditionInfo condition ,Array accessRoles)
指定した検索条件とアクセスロールでルート詳細情報の検索結果件数を取得します。
WorkflowResultInfo getRouteDetailDataListCountWithLocale (String routeId ,String localeId)
指定したロケールIDでルート詳細情報の全バージョン分の件数を取得します。
WorkflowResultInfo getRouteDetailDataListFamilyWithLocale (String routeId ,String localeId)
指定したロケールIDでルート詳細情報と配下の情報を全バージョン分取得します。
WorkflowResultInfo getRouteDetailDataListFamilyWithLocaleAndVersionStatuses (String routeId ,String localeId ,Array versionStatuses)
指定したロケールIDとバージョンステータスでルート詳細情報と配下の情報を全バージョン分取得します。
WorkflowResultInfo getRouteDetailDataListWithAccessRole (String routeId ,RouteDataSearchConditionInfo condition ,Array accessRoles)
指定した検索条件とアクセスロールでルート詳細情報を検索します。
WorkflowResultInfo getRouteDetailDataListWithLocale (String routeId ,String localeId)
指定したロケールIDでルート詳細情報を全バージョン分取得します。
WorkflowResultInfo getRouteDetailDataListWithLocaleAndVersionStatuses (String routeId ,String localeId ,Array versionStatuses)
指定したロケールIDとバージョンステータスでルート詳細情報を全バージョン分取得します。
WorkflowResultInfo getRouteDetailDataWithLocale (String routeId ,String routeVersionId ,String localeId)
指定したロケールIDでルート詳細情報を1件取得します。
WorkflowResultInfo getRouteNodeData (RouteDetailDataInfo model)
指定したルート詳細情報でルート情報ノード定義情報を取得します。
WorkflowResultInfo getRoutePluginData (String routeId ,String routeVersionId)
ルートユーザ設定情報を取得します。
WorkflowResultInfo getRoutePluginDataCount (String routeId ,String routeVersionId)
ルートユーザ設定情報の全ノード、全ロケール分の件数を取得します。
WorkflowResultInfo getRoutePluginDataCountWithNode (String routeId ,String routeVersionId ,String nodeId)
指定したノードIDでルートユーザ設定情報の件数を取得します。
WorkflowResultInfo getRoutePluginDataWithNode (String routeId ,String routeVersionId ,String nodeId)
指定したノードIDでルートユーザ設定情報を取得します。
WorkflowResultInfo updateRouteData (Array models)
ルート情報を更新します。
WorkflowResultInfo updateRouteDataFamily (Array models)
ルート情報と配下の情報を更新します。
WorkflowResultInfo updateRouteDataWithAdjust (Array models)
ルート情報と配下の情報を自動調整し更新します。
WorkflowResultInfo updateRouteDetailData (Array models)
ルート詳細情報を更新します。
WorkflowResultInfo updateRouteDetailDataFamily (Array models)
ルート詳細情報と配下の情報を更新します。
WorkflowResultInfo updateRouteDetailDataWithAdjust (Array models)
ルート詳細情報と配下の情報を自動調整し更新します。
WorkflowResultInfo updateRoutePluginData (Array models)
ルートユーザ設定情報を更新します。

コンストラクタの詳細
RouteDataManager

RouteDataManager (String loginGroupId)
コンストラクタ
引数で指定したログイングループIDでルート定義情報管理マネージャを新しく生成します。
パラメータ
loginGroupId String ログイングループID

メソッドの詳細
createRouteData

WorkflowResultInfo createRouteData (Array models)

ルート情報を新規作成します。

ルート詳細情報、および、各連携情報は新規作成しません。
全ての情報を新規作成する場合は createRouteDataFamily、または、createRouteDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためにはルート詳細情報、および、各連携情報の作成が必要です。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRouteDataFamily

WorkflowResultInfo createRouteDataFamily (Array models)

ルート情報と配下の情報を新規作成します。

指定したルート情報、ルート詳細情報、および、各連携情報に基づいて新規作成しますが、データ矛盾のチェックを行いません。

各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート情報配下にあるルート詳細情報のルートID、ロケールIDはルート情報の設定内容に自動的に置き換わります。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
ルート詳細情報、および、各連携情報を自動的に新規作成し、登録済みバージョンの期間調整を行う場合は createRouteDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRouteDataWithAdjust

WorkflowResultInfo createRouteDataWithAdjust (Array models)

ルート情報と配下の情報を自動調整し新規作成します。

指定したルート情報、ルート詳細情報、および、各連携情報に基づいて新規作成を行い、データ矛盾がある場合は自動的に調整します。

models 内のルートID、ルートバージョンID、ロケールID、開始日、終了日、バージョンステータスは必須で、それ以外の項目は任意です。
models には複数のルート情報、ルート詳細情報、および、各連携情報を指定することができます。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート情報配下にあるルート詳細情報のルートID、ロケールIDはルート情報の設定内容に自動的に置き換わります。

ルートID、ロケールIDに紐付く登録済みのバージョンに対してバージョン期間の調整を行います。
指定したルート詳細情報のバージョン期間と完全に重複するバージョンは削除され、一部期間が重複するバージョンは隣接するバージョンの期間を重ならないように調整します。
空白のバージョン期間が存在する場合は、システム無効バージョンを新規作成して空白期間を埋めます。
ルート詳細情報を指定しない場合、かつ、ルートバージョンが1つも登録されていない場合は、システム無効バージョンを1つだけ新規作成します。

指定したルート定義がすでにフロー定義で使用されている場合は、使用しているフロー詳細情報配下の各連携情報に初期値を補完します。 すでに最低限の設定が行われている場合は補完しません。

ロケールIDが異なる複数のデータを取り扱う場合は、必ず配列にまとめて本メソッドを1度だけ呼び出してください。
複数回に分けて処理を行うと、ルートバージョンIDが正しく採番されないことがあります。

異なるルートとしてバージョンのコピーを行う場合は、新しくルート情報を作成してルートIDを設定し、getRouteDetailDataFamily の結果を格納して本メソッドを呼び出してください。
同じルート内でバージョンのコピーを行う場合は、createRouteDetailDataWithAdjust を使用してください。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRouteDetailData

WorkflowResultInfo createRouteDetailData (Array models)

ルート詳細情報を新規作成します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は新規作成しません。
全ての情報を新規作成する場合は createRouteDetailDataFamily、または、 createRouteDetailDataWithAdjust を使用してください。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に新規作成し、登録済みバージョンの期間調整を行う場合は createRouteDetailDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRouteDetailDataFamily

WorkflowResultInfo createRouteDetailDataFamily (Array models)

ルート詳細情報と配下の情報を新規作成します。

指定したルート詳細情報、および、各連携情報に基づいて新規作成しますが、データ矛盾のチェックを行いません。

各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート詳細情報配下にある各連携情報のルートID、ルートバージョンID、ロケールIDはルート詳細情報の設定内容に自動的に置き換わります。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に新規作成し、登録済みバージョンの期間調整を行う場合は createRouteDetailDataWithAdjust を使用してください。

ルート定義XMLファイルの内容を指定している場合は、ルート定義XMLファイルの新規作成を行います。
ルート定義XMLファイルのパスが指定されていない場合は、自動的にデフォルトのパスを補完します。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRouteDetailDataWithAdjust

WorkflowResultInfo createRouteDetailDataWithAdjust (Array models)

ルート詳細情報と配下の情報を自動調整し新規作成します。

指定したルート詳細情報、および、各連携情報に基づいて新規作成を行い、データ矛盾がある場合は自動的に調整します。

models 内のルートID、ルートバージョンID、ロケールID、開始日、終了日、バージョンステータスは必須で、それ以外の項目は任意です。
models には複数のルート詳細情報、および、各連携情報を指定することができます。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート詳細情報配下にある各連携情報のルートID、ルートバージョンID、ロケールIDはルート詳細情報の設定内容に自動的に置き換わります。

ルート定義XMLファイルの内容を指定している場合は、ルート定義XMLファイルの新規作成を行います。
ルート定義XMLファイルのパスが指定されていない場合は、自動的にデフォルトのパスを補完します。

ルートID、ロケールIDに紐付く登録済みのバージョンに対してバージョン期間の調整を行います。
指定したルート詳細情報のバージョン期間と完全に重複するバージョンは削除され、一部期間が重複するバージョンは隣接するバージョンの期間を重ならないように調整します。
空白のバージョン期間が存在する場合は、システム無効バージョンを新規作成して空白期間を埋めます。

指定したルート定義がすでにフロー定義で使用されている場合は、使用しているフロー詳細情報配下の各連携情報に初期値を補完します。 すでに最低限の設定が行われている場合は補完しません。

ロケールIDが異なる複数のデータを取り扱う場合は、必ず配列にまとめて本メソッドを1度だけ呼び出してください。
複数回に分けて処理を行うと、ルートバージョンIDが正しく採番されないことがあります。

同じルート内にバージョンのコピーを行う場合は、getRouteDetailDataFamily の処理結果に新しく採番したルートバージョンIDを設定して、本メソッドを呼び出してください。
異なるルートとしてバージョンのコピーを行う場合は、createRouteDataWithAdjust を使用してください。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

createRoutePluginData

WorkflowResultInfo createRoutePluginData (Array models)

ルートユーザ設定情報を新規作成します。
パラメータ
models Array ルートユーザ設定情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRouteData

WorkflowResultInfo deleteRouteData (Array models)

ルート情報を削除します。

ルート詳細情報、および、各連携情報は削除しません。
全ての情報を削除する場合は deleteRouteDataFamily を使用してください。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRouteDataFamily

WorkflowResultInfo deleteRouteDataFamily (Array models)

ルート情報と配下の情報を削除します。

指定したルート情報、ルート詳細情報、および、各連携情報の指定に関わらず、キー情報に一致するルート情報配下の情報を全て削除します。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRouteDetailData

WorkflowResultInfo deleteRouteDetailData (Array models)

ルート詳細情報を削除します。

ルート詳細情報配下の各連携情報は削除しません。
全ての情報を削除する場合は deleteRouteDetailDataFamily、または、 deleteRouteDetailDataWithAdjust を使用してください。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に削除し、登録済みバージョンの自動調整を行う場合は deleteRouteDetailDataWithAdjust を使用してください。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRouteDetailDataFamily

WorkflowResultInfo deleteRouteDetailDataFamily (Array models)

ルート詳細情報と配下の情報を削除します。

指定したルート詳細情報、および、各連携情報の指定に関わらず、キー情報に一致するルート詳細情報配下の情報と、ルート定義XMLファイルを全て削除します。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に削除し、登録済みバージョンの自動調整を行う場合は deleteRouteDetailDataWithAdjust を使用してください。

ルート詳細情報に指定したルート定義XMLファイルのパスは無視され、自動的に最新のパスを取得してルート定義XMLファイルの削除を行います。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRouteDetailDataWithAdjust

WorkflowResultInfo deleteRouteDetailDataWithAdjust (Array models)

ルート詳細情報と配下の情報を自動調整し削除します。

models 内のルートID、ルートバージョンIDは必須で、それ以外の項目は任意です。
ロケールIDに null を指定した場合は、登録されている全ロケール分を削除します。
ルートID、ルートバージョンID、ロケールID以外の項目は無視します。

ルートID、ロケールIDに紐付く登録済みのバージョンに対してバージョン期間の調整を行います。
空白のバージョン期間が存在する場合は、システム無効バージョンを新規作成して空白期間を埋めます。

指定したルート詳細情報、および、各連携情報の指定に関わらず、キー情報に一致するルート詳細情報配下の情報と、ルート定義XMLファイルを全て削除します。
指定したルート定義がすでにフロー定義で使用されている場合は、使用しているフロー詳細情報配下の各連携情報も削除します。 フロー詳細情報(フローバージョン)は更新しません。

ロケールIDが異なる複数のデータを取り扱う場合は、必ず配列にまとめて本メソッドを1度だけ呼び出してください。
複数回に分けて処理を行うと、ルート詳細情報の整合性が保証されない場合があります。

ワークフロー上でルート詳細情報を使用可能にするためには、登録済みバージョンの期間調整が必要です。
ルート詳細情報を削除する場合は本メソッドを使用してください。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

deleteRoutePluginData

WorkflowResultInfo deleteRoutePluginData (Array models)

ルートユーザ設定情報を削除します。
パラメータ
models Array ルートユーザ設定情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

getRouteData

WorkflowResultInfo getRouteData (String routeId)

ルート情報を全ロケール分取得します。

ルート詳細情報、および、各連携情報は取得しません。
全ての情報を取得する場合は getRouteDataFamily を使用してください。

ロケールの指定を行う場合は getRouteDataWithLocale を使用してください。
パラメータ
routeId String ルートID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトの配列が設定されます。

getRouteDataCount

WorkflowResultInfo getRouteDataCount (String routeId)

ルート情報の全ロケール分の件数を取得します。

ロケールの指定を行う場合は getRouteDataCountWithLocale を使用してください。
パラメータ
routeId String ルートID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報の件数(Number)が設定されます。

getRouteDataCountWithLocale

WorkflowResultInfo getRouteDataCountWithLocale (String routeId ,String localeId)

指定したロケールIDでルート情報の件数を取得します。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報の件数(Number)が設定されます。

getRouteDataFamily

WorkflowResultInfo getRouteDataFamily (String routeId)

ルート情報と配下の情報を全ロケール分取得します。

ルート詳細情報と配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。

ロケールの指定を行う場合は getRouteDataFamilyWithLocale を使用してください。
パラメータ
routeId String ルートID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトの配列が設定されます。

getRouteDataFamilyWithLocale

WorkflowResultInfo getRouteDataFamilyWithLocale (String routeId ,String localeId)

指定したロケールIDでルート情報と配下の情報を1件取得します。

ルート詳細情報と配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
各情報のうち、国際化対応されているものに関しては、指定したロケールIDのみを取得します。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。

該当するルート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトが設定されます。

getRouteDataList

WorkflowResultInfo getRouteDataList (RouteDataSearchConditionInfo condition)

指定した検索条件でルート情報を検索します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

ルート詳細情報、および、各連携情報は取得しません。

アクセスロールの指定を行う場合は getRouteDataListWithAccessRole を使用してください。
パラメータ
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトの配列が設定されます。

getRouteDataListCount

WorkflowResultInfo getRouteDataListCount (RouteDataSearchConditionInfo condition)

指定した検索条件でルート情報の検索結果件数を取得します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getRouteDataListCountWithAccessRole を使用してください。
パラメータ
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報の件数(Number)が設定されます。

getRouteDataListCountWithAccessRole

WorkflowResultInfo getRouteDataListCountWithAccessRole (RouteDataSearchConditionInfo condition ,Array accessRoles)

指定した検索条件とアクセスロールでルート情報の検索結果件数を取得します。

指定したアクセスロールに紐付き、参照権限があるルート情報をカウント対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
accessRoles Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報の件数(Number)が設定されます。

getRouteDataListWithAccessRole

WorkflowResultInfo getRouteDataListWithAccessRole (RouteDataSearchConditionInfo condition ,Array accessRoles)

指定した検索条件とアクセスロールでルート情報を検索します。

指定したアクセスロールに紐付き、参照権限があるルート情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

ルート詳細情報、および、各連携情報は取得しません。
パラメータ
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
accessRoles Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトの配列が設定されます。

getRouteDataWithLocale

WorkflowResultInfo getRouteDataWithLocale (String routeId ,String localeId)

指定したロケールIDでルート情報を1件取得します。

ルート詳細情報、および、各連携情報は取得しません。
全ての情報を取得する場合は getRouteDataFamilyWithLocale を使用してください。

該当するルート情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報オブジェクトが設定されます。

getRouteDetailData

WorkflowResultInfo getRouteDetailData (String routeId ,String routeVersionId)

ルート詳細情報を全ロケール分取得します。

ルート詳細情報配下の各連携情報は取得しませんが、ルート定義XMLファイル情報を取得します。
全ての情報を取得する場合は getRouteDetailDataFamily を使用してください。

ロケールの指定を行う場合は getRouteDetailDataWithLocale を使用してください。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataCount

WorkflowResultInfo getRouteDetailDataCount (String routeId ,String routeVersionId)

ルート詳細情報の全ロケール分の件数を取得します。

ロケールの指定を行う場合は getRouteDetailDataCountWithLocale を使用してください。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報の件数(Number)が設定されます。

getRouteDetailDataCountWithLocale

WorkflowResultInfo getRouteDetailDataCountWithLocale (String routeId ,String routeVersionId ,String localeId)

指定したロケールIDでルート詳細情報の件数を取得します。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報の件数(Number)が設定されます。

getRouteDetailDataFamily

WorkflowResultInfo getRouteDetailDataFamily (String routeId ,String routeVersionId)

ルート詳細情報と配下の情報を全ロケール分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。

ロケールの指定を行う場合は getRouteDetailDataFamilyWithLocale を使用してください。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataFamilyWithLocale

WorkflowResultInfo getRouteDetailDataFamilyWithLocale (String routeId ,String routeVersionId ,String localeId)

指定したロケールIDでルート詳細情報と配下の情報を1件取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
各情報のうち、国際化対応されているものに関しては、指定したロケールIDのみを取得します。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。

該当するルート詳細情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトが設定されます。

getRouteDetailDataList

WorkflowResultInfo getRouteDetailDataList (String routeId ,RouteDataSearchConditionInfo condition)

指定した検索条件でルート詳細情報を検索します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は取得しません。

アクセスロールの指定を行う場合は getRouteDetailDataListWithAccessRole を使用してください。
パラメータ
routeId String ルートID
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataListCount

WorkflowResultInfo getRouteDetailDataListCount (String routeId ,RouteDataSearchConditionInfo condition)

指定した検索条件でルート詳細情報の検索結果件数を取得します。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

アクセスロールの指定を行う場合は getRouteDetailDataListCountWithAccessRole を使用してください。
パラメータ
routeId String ルートID
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報の件数(Number)が設定されます。

getRouteDetailDataListCountWithAccessRole

WorkflowResultInfo getRouteDetailDataListCountWithAccessRole (String routeId ,RouteDataSearchConditionInfo condition ,Array accessRoles)

指定した検索条件とアクセスロールでルート詳細情報の検索結果件数を取得します。

指定したアクセスロールに紐付き、参照権限があるルート詳細情報をカウント対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
routeId String ルートID
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
accessRoles Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報の件数(Number)が設定されます。

getRouteDetailDataListCountWithLocale

WorkflowResultInfo getRouteDetailDataListCountWithLocale (String routeId ,String localeId)

指定したロケールIDでルート詳細情報の全バージョン分の件数を取得します。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報の件数(Number)が設定されます。

getRouteDetailDataListFamilyWithLocale

WorkflowResultInfo getRouteDetailDataListFamilyWithLocale (String routeId ,String localeId)

指定したロケールIDでルート詳細情報と配下の情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataListFamilyWithLocaleAndVersionStatuses

WorkflowResultInfo getRouteDetailDataListFamilyWithLocaleAndVersionStatuses (String routeId ,String localeId ,Array versionStatuses)

指定したロケールIDとバージョンステータスでルート詳細情報と配下の情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。
バージョンステータスには、ユーザ有効化・ユーザ無効化・システム無効化のいずれかを指定してください。
パラメータ
routeId String ルートID
localeId String ロケールID
versionStatuses Array バージョンステータスの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataListWithAccessRole

WorkflowResultInfo getRouteDetailDataListWithAccessRole (String routeId ,RouteDataSearchConditionInfo condition ,Array accessRoles)

指定した検索条件とアクセスロールでルート詳細情報を検索します。

指定したアクセスロールに紐付き、参照権限があるルート詳細情報を検索対象にします。

condition で指定したロケールIDを検索条件に使用します。
null を指定した場合は、登録されている全ロケール分を取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は取得しません。
パラメータ
routeId String ルートID
condition RouteDataSearchConditionInfo ルート定義一覧情報検索条件情報オブジェクト
accessRoles Array アクセスロールの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataListWithLocale

WorkflowResultInfo getRouteDetailDataListWithLocale (String routeId ,String localeId)

指定したロケールIDでルート詳細情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は取得しません。
ルート定義XMLファイル情報を除き、全ての情報を取得する場合は getRouteDetailDataListFamilyWithLocale を使用してください。
パラメータ
routeId String ルートID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataListWithLocaleAndVersionStatuses

WorkflowResultInfo getRouteDetailDataListWithLocaleAndVersionStatuses (String routeId ,String localeId ,Array versionStatuses)

指定したロケールIDとバージョンステータスでルート詳細情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は取得しません。
ルート定義XMLファイル情報を除き、全ての情報を取得する場合は getRouteDetailDataListFamilyWithLocaleAndVersionStatuses を使用してください。
バージョンステータスには、ユーザ有効化・ユーザ無効化・システム無効化のいずれかを指定してください。
パラメータ
routeId String ルートID
localeId String ロケールID
versionStatuses Array バージョンステータスの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトの配列が設定されます。

getRouteDetailDataWithLocale

WorkflowResultInfo getRouteDetailDataWithLocale (String routeId ,String routeVersionId ,String localeId)

指定したロケールIDでルート詳細情報を1件取得します。

ルート詳細情報配下の各連携情報は取得しませんが、ルート定義XMLファイル情報を取得します。
全ての情報を取得する場合は getRouteDetailDataFamilyWithLocale を使用してください。

該当するルート詳細情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
localeId String ロケールID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート詳細情報オブジェクトが設定されます。

getRouteNodeData

WorkflowResultInfo getRouteNodeData (RouteDetailDataInfo model)

指定したルート詳細情報でルート情報ノード定義情報を取得します。

ルート情報を格納したXMLを読み取り、ルート詳細情報内のロケールIDに一致するノード情報を取得します。
コメント、スイムレーンの情報は含まれません。
ルート詳細情報にルート定義XMLファイルのパスが指定されていない場合は、処理結果のdata属性にnullが設定されます。

本メソッドを使用する場合は、getRouteDetailData などの各取得メソッドで取得したルート詳細情報を引数に指定してください。
空の状態から作成したルート詳細情報を指定すると、正しい動作が保証されない場合があります。

フロー情報管理マネージャ(FlowDataManager)にも同じ機能が提供されていますが、本メソッドではテンプレート置換ノードを展開せずに出力します。
テンプレート置換ノードを展開したルート情報ノード定義情報を取得する場合は、フロー情報管理マネージャを使用してください。
パラメータ
model RouteDetailDataInfo ルート詳細情報オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルート情報ノード定義情報オブジェクトの配列が設定されます。

getRoutePluginData

WorkflowResultInfo getRoutePluginData (String routeId ,String routeVersionId)

ルートユーザ設定情報を取得します。

ノードの指定を行う場合は getRoutePluginDataWithNode を使用してください。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルートユーザ設定情報オブジェクトの配列が設定されます。

getRoutePluginDataCount

WorkflowResultInfo getRoutePluginDataCount (String routeId ,String routeVersionId)

ルートユーザ設定情報の全ノード、全ロケール分の件数を取得します。

ノードの指定を行う場合は getRoutePluginDataCountWithNode を使用してください。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルートユーザ設定情報の件数(Number)が設定されます。

getRoutePluginDataCountWithNode

WorkflowResultInfo getRoutePluginDataCountWithNode (String routeId ,String routeVersionId ,String nodeId)

指定したノードIDでルートユーザ設定情報の件数を取得します。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
nodeId String ノードID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルートユーザ設定情報の件数(Number)が設定されます。

getRoutePluginDataWithNode

WorkflowResultInfo getRoutePluginDataWithNode (String routeId ,String routeVersionId ,String nodeId)

指定したノードIDでルートユーザ設定情報を取得します。
パラメータ
routeId String ルートID
routeVersionId String ルートバージョンID
nodeId String ノードID
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ルートユーザ設定情報オブジェクトの配列が設定されます。

updateRouteData

WorkflowResultInfo updateRouteData (Array models)

ルート情報を更新します。

ルート詳細情報、および、各連携情報は更新しません。
全ての情報を更新する場合は updateRouteDataFamily、または、updateRouteDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためにはルート詳細情報、および、各連携情報の更新が必要です。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRouteDataFamily

WorkflowResultInfo updateRouteDataFamily (Array models)

ルート情報と配下の情報を更新します。

指定したルート情報、ルート詳細情報、および、各連携情報に基づいて更新しますが、データ矛盾のチェックを行いません。

models 内のルートID、ロケールIDは必須で、それ以外の項目は任意です。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート情報配下にあるルート詳細情報のルートID、ロケールIDはルート情報の設定内容に自動的に置き換わります。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
ルート詳細情報、および、各連携情報を自動的に更新し、登録済みバージョンの期間調整を行う場合は updateRouteDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRouteDataWithAdjust

WorkflowResultInfo updateRouteDataWithAdjust (Array models)

ルート情報と配下の情報を自動調整し更新します。

指定したルート情報、ルート詳細情報、および、各連携情報に基づいて更新を行い、データ矛盾がある場合は自動的に調整します。

models 内のルートID、ルートバージョンID、ロケールID、開始日、終了日、バージョンステータスは必須で、それ以外の項目は任意です。
models には複数のルート情報、ルート詳細情報、および、各連携情報を指定することができます。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート情報配下にあるルート詳細情報のルートID、ロケールIDはルート情報の設定内容に自動的に置き換わります。

ルートID、ロケールIDに紐付く登録済みのバージョンに対してバージョン期間の調整を行います。
指定したルート詳細情報のバージョン期間と完全に重複するバージョンは削除され、一部期間が重複するバージョンは隣接するバージョンの期間を重ならないように調整します。
空白のバージョン期間が存在する場合は、システム無効バージョンを新規作成して空白期間を埋めます。
ルート詳細情報を指定しない場合、かつ、ルートバージョンが1つも登録されていない場合は、システム無効バージョンを1つだけ新規作成します。

指定したルート定義がすでにフロー定義で使用されている場合は、使用しているフロー詳細情報配下の各連携情報に初期値を補完します。 すでに最低限の設定が行われている場合は補完しません。

ロケールIDが異なる複数のデータを取り扱う場合は、必ず配列にまとめて本メソッドを1度だけ呼び出してください。
複数回に分けて処理を行うと、ルートバージョンIDが正しく採番されないことがあります。

ルート詳細情報と配下の情報を更新しない場合は、updateRouteData を使用することでシステム負荷を抑えることができます。
パラメータ
models Array ルート情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRouteDetailData

WorkflowResultInfo updateRouteDetailData (Array models)

ルート詳細情報を更新します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は更新しません。
全ての情報を更新する場合は updateRouteDetailDataFamily、または、 updateRouteDetailDataWithAdjust を使用してください。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に更新し、登録済みバージョンの期間調整を行う場合は updateRouteDetailDataWithAdjust を使用してください。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRouteDetailDataFamily

WorkflowResultInfo updateRouteDetailDataFamily (Array models)

ルート詳細情報と配下の情報を更新します。

指定したルート詳細情報、および、各連携情報に基づいて更新しますが、データ矛盾のチェックを行いません。

models 内のルートID、ルートバージョンID、ロケールIDは必須で、それ以外の項目は任意です。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート詳細情報配下にある各連携情報のルートID、ルートバージョンID、ロケールIDはルート詳細情報の設定内容に自動的に置き換わります。

すでに登録済みのバージョンに対して期間調整や自動削除は一切行いません。
各連携情報を自動的に更新し、登録済みバージョンの期間調整を行う場合は updateRouteDetailDataWithAdjust を使用してください。

ルート定義XMLファイルのパス、および、ルート定義XMLファイルの内容を指定している場合は、ルート定義XMLファイルの更新を行います。指定していない場合はファイルを削除します。

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRouteDetailDataWithAdjust

WorkflowResultInfo updateRouteDetailDataWithAdjust (Array models)

ルート詳細情報と配下の情報を自動調整し更新します。

指定したルート詳細情報、および、各連携情報に基づいて更新を行い、データ矛盾がある場合は自動的に調整します。

models 内のルートID、ルートバージョンID、ロケールID、開始日、終了日、バージョンステータスは必須で、それ以外の項目は任意です。
models には複数のルート詳細情報、および、各連携情報を指定することができます。
各情報のキー値は親情報のキー値に自動的に統一します。 例えば、ルート詳細情報配下にある各連携情報のルートID、ルートバージョンID、ロケールIDはルート詳細情報の設定内容に自動的に置き換わります。

ルート定義XMLファイルのパス、および、ルート定義XMLファイルの内容を指定している場合は、ルート定義XMLファイルの更新を行います。指定していない場合はファイルを削除します。

ルートID、ロケールIDに紐付く登録済みのバージョンに対してバージョン期間の調整を行います。
指定したルート詳細情報のバージョン期間と完全に重複するバージョンは削除され、一部期間が重複するバージョンは隣接するバージョンの期間を重ならないように調整します。
空白のバージョン期間が存在する場合は、システム無効バージョンを新規作成して空白期間を埋めます。

指定したルート定義がすでにフロー定義で使用されている場合は、使用しているフロー詳細情報配下の各連携情報に初期値を補完します。 すでに最低限の設定が行われている場合は補完しません。

ロケールIDが異なる複数のデータを取り扱う場合は、必ず配列にまとめて本メソッドを1度だけ呼び出してください。
複数回に分けて処理を行うと、ルートバージョンIDが正しく採番されないことがあります。

バージョン期間と配下の情報を更新しない場合は、updateRouteDetailData を使用することでシステム負荷を抑えることができます。
パラメータ
models Array ルート詳細情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

updateRoutePluginData

WorkflowResultInfo updateRoutePluginData (Array models)

ルートユーザ設定情報を更新します。
パラメータ
models Array ルートユーザ設定情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。