IM-Workflow

jp.co.intra_mart.foundation.workflow.administrator
クラス RouteDataManager

java.lang.Object
  上位を拡張 jp.co.intra_mart.foundation.workflow.administrator.RouteDataManager

public class RouteDataManager
extends Object

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

ルート定義情報およびルート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でルート定義情報管理マネージャを新しく生成します。
 
メソッドの概要
 void abortFileControl()
          ルート定義のXMLファイルの操作を取消します。
 void beginFileControl()
          ルート定義のXMLファイルを操作する準備を行います。
 void createRouteData(RouteDataModel... models)
          ルート情報を新規作成します。
 void createRouteDataFamily(RouteDataModel... models)
          ルート情報と配下の情報を新規作成します。
 void createRouteDataWithAdjust(RouteDataModel... models)
          ルート情報と配下の情報を自動調整し新規作成します。
 void createRouteDetailData(RouteDetailDataModel... models)
          ルート詳細情報を新規作成します。
 void createRouteDetailDataFamily(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を新規作成します。
 void createRouteDetailDataWithAdjust(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を自動調整し新規作成します。
 void createRoutePluginData(RoutePluginDataModel... models)
          ルートユーザ設定情報を新規作成します。
 void deleteRouteData(RouteDataModel... models)
          ルート情報を削除します。
 void deleteRouteDataFamily(RouteDataModel... models)
          ルート情報と配下の情報を削除します。
 void deleteRouteDetailData(RouteDetailDataModel... models)
          ルート詳細情報を削除します。
 void deleteRouteDetailDataFamily(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を削除します。
 void deleteRouteDetailDataWithAdjust(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を自動調整し削除します。
 void deleteRoutePluginData(RoutePluginDataModel... models)
          ルートユーザ設定情報を削除します。
 void flushFileControl()
          ルート定義のXMLファイルの変更を確定します。
 RouteDataModel[] getRouteData(String routeId)
          ルート情報を全ロケール分取得します。
 int getRouteDataCount(String routeId)
          ルート情報の全ロケール分の件数を取得します。
 int getRouteDataCountWithLocale(String routeId, String localeId)
          指定したロケールIDでルート情報の件数を取得します。
 RouteDataModel[] getRouteDataFamily(String routeId)
          ルート情報と配下の情報を全ロケール分取得します。
 RouteDataModel getRouteDataFamilyWithLocale(String routeId, String localeId)
          指定したロケールIDでルート情報と配下の情報を1件取得します。
 RouteDataModel[] getRouteDataList(RouteDataSearchConditionInfo condition)
          指定した検索条件でルート情報を検索します。
 int getRouteDataListCount(RouteDataSearchConditionInfo condition)
          指定した検索条件でルート情報の検索結果件数を取得します。
 int getRouteDataListCountWithAccessRole(RouteDataSearchConditionInfo condition, String... accessRoles)
          指定した検索条件とアクセスロールでルート情報の検索結果件数を取得します。
 RouteDataModel[] getRouteDataListWithAccessRole(RouteDataSearchConditionInfo condition, String... accessRoles)
          指定した検索条件とアクセスロールでルート情報を検索します。
 RouteDataModel getRouteDataWithLocale(String routeId, String localeId)
          指定したロケールIDでルート情報を1件取得します。
 RouteDetailDataModel[] getRouteDetailData(String routeId, String routeVersionId)
          ルート詳細情報を全ロケール分取得します。
 int getRouteDetailDataCount(String routeId, String routeVersionId)
          ルート詳細情報の全ロケール分の件数を取得します。
 int getRouteDetailDataCountWithLocale(String routeId, String routeVersionId, String localeId)
          指定したロケールIDでルート詳細情報の件数を取得します。
 RouteDetailDataModel[] getRouteDetailDataFamily(String routeId, String routeVersionId)
          ルート詳細情報と配下の情報を全ロケール分取得します。
 RouteDetailDataModel getRouteDetailDataFamilyWithLocale(String routeId, String routeVersionId, String localeId)
          指定したロケールIDでルート詳細情報と配下の情報を1件取得します。
 RouteDetailDataModel[] getRouteDetailDataList(String routeId, RouteDataSearchConditionInfo condition)
          指定した検索条件でルート詳細情報を検索します。
 int getRouteDetailDataListCount(String routeId, RouteDataSearchConditionInfo condition)
          指定した検索条件でルート詳細情報の検索結果件数を取得します。
 int getRouteDetailDataListCountWithAccessRole(String routeId, RouteDataSearchConditionInfo condition, String... accessRoles)
          指定した検索条件とアクセスロールでルート詳細情報の検索結果件数を取得します。
 int getRouteDetailDataListCountWithLocale(String routeId, String localeId)
          指定したロケールIDでルート詳細情報の全バージョン分の件数を取得します。
 RouteDetailDataModel[] getRouteDetailDataListFamilyWithLocale(String routeId, String localeId)
          指定したロケールIDでルート詳細情報と配下の情報を全バージョン分取得します。
 RouteDetailDataModel[] getRouteDetailDataListFamilyWithLocaleAndVersionStatuses(String routeId, String localeId, String... versionStatuses)
          指定したロケールIDとバージョンステータスでルート詳細情報と配下の情報を全バージョン分取得します。
 RouteDetailDataModel[] getRouteDetailDataListWithAccessRole(String routeId, RouteDataSearchConditionInfo condition, String... accessRoles)
          指定した検索条件とアクセスロールでルート詳細情報を検索します。
 RouteDetailDataModel[] getRouteDetailDataListWithLocale(String routeId, String localeId)
          指定したロケールIDでルート詳細情報を全バージョン分取得します。
 RouteDetailDataModel[] getRouteDetailDataListWithLocaleAndVersionStatuses(String routeId, String localeId, String... versionStatuses)
          指定したロケールIDとバージョンステータスでルート詳細情報を全バージョン分取得します。
 RouteDetailDataModel getRouteDetailDataWithLocale(String routeId, String routeVersionId, String localeId)
          指定したロケールIDでルート詳細情報を1件取得します。
 RouteNodeDataModel[] getRouteNodeData(RouteDetailDataModel model)
          指定したルート詳細情報でルート情報ノード定義情報を取得します。
 RoutePluginDataModel[] getRoutePluginData(String routeId, String routeVersionId)
          ルートユーザ設定情報を取得します。
 int getRoutePluginDataCount(String routeId, String routeVersionId)
          ルートユーザ設定情報の全ノード、全ロケール分の件数を取得します。
 int getRoutePluginDataCountWithNode(String routeId, String routeVersionId, String nodeId)
          指定したノードIDでルートユーザ設定情報の件数を取得します。
 RoutePluginDataModel[] getRoutePluginDataWithNode(String routeId, String routeVersionId, String nodeId)
          指定したノードIDでルートユーザ設定情報を取得します。
 void updateRouteData(RouteDataModel... models)
          ルート情報を更新します。
 void updateRouteDataFamily(RouteDataModel... models)
          ルート情報と配下の情報を更新します。
 void updateRouteDataWithAdjust(RouteDataModel... models)
          ルート情報と配下の情報を自動調整し更新します。
 void updateRouteDetailData(RouteDetailDataModel... models)
          ルート詳細情報を更新します。
 void updateRouteDetailDataFamily(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を更新します。
 void updateRouteDetailDataWithAdjust(RouteDetailDataModel... models)
          ルート詳細情報と配下の情報を自動調整し更新します。
 void updateRoutePluginData(RoutePluginDataModel... models)
          ルートユーザ設定情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

RouteDataManager

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

パラメータ:
loginGroupId - ログイングループID
メソッドの詳細

getRouteDataList

public RouteDataModel[] getRouteDataList(RouteDataSearchConditionInfo condition)
                                  throws WorkflowException
指定した検索条件でルート情報を検索します。

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

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

アクセスロールの指定を行う場合は getRouteDataListWithAccessRole を使用してください。

パラメータ:
condition - ルート定義一覧情報検索条件情報
戻り値:
RouteDataModel[] ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataListWithAccessRole

public RouteDataModel[] getRouteDataListWithAccessRole(RouteDataSearchConditionInfo condition,
                                                       String... accessRoles)
                                                throws WorkflowException
指定した検索条件とアクセスロールでルート情報を検索します。

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

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

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

パラメータ:
condition - ルート定義一覧情報検索条件情報
accessRoles - アクセスロールの配列
戻り値:
RouteDataModel[] ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteData

public RouteDataModel[] getRouteData(String routeId)
                              throws WorkflowException
ルート情報を全ロケール分取得します。

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

ロケールの指定を行う場合は getRouteDataWithLocale を使用してください。

パラメータ:
routeId - ルートID
戻り値:
RouteDataModel[] ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataWithLocale

public RouteDataModel getRouteDataWithLocale(String routeId,
                                             String localeId)
                                      throws WorkflowException
指定したロケールIDでルート情報を1件取得します。

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

該当するルート情報が見つからなかった場合は、null を返却します。

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
RouteDataModel ルート情報
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataFamily

public RouteDataModel[] getRouteDataFamily(String routeId)
                                    throws WorkflowException
ルート情報と配下の情報を全ロケール分取得します。

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

ロケールの指定を行う場合は getRouteDataFamilyWithLocale を使用してください。

パラメータ:
routeId - ルートID
戻り値:
RouteDataModel[] ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataFamilyWithLocale

public RouteDataModel getRouteDataFamilyWithLocale(String routeId,
                                                   String localeId)
                                            throws WorkflowException
指定したロケールIDでルート情報と配下の情報を1件取得します。

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

該当するルート情報が見つからなかった場合は、null を返却します。

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
RouteDataModel ルート情報
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataListCount

public int getRouteDataListCount(RouteDataSearchConditionInfo condition)
                          throws WorkflowException
指定した検索条件でルート情報の検索結果件数を取得します。

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

アクセスロールの指定を行う場合は getRouteDataListCountWithAccessRole を使用してください。

パラメータ:
condition - ルート定義一覧情報検索条件情報
戻り値:
int ルート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataListCountWithAccessRole

public int getRouteDataListCountWithAccessRole(RouteDataSearchConditionInfo condition,
                                               String... accessRoles)
                                        throws WorkflowException
指定した検索条件とアクセスロールでルート情報の検索結果件数を取得します。

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

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

パラメータ:
condition - ルート定義一覧情報検索条件情報
accessRoles - アクセスロールの配列
戻り値:
int ルート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataCount

public int getRouteDataCount(String routeId)
                      throws WorkflowException
ルート情報の全ロケール分の件数を取得します。

ロケールの指定を行う場合は getRouteDataCountWithLocale を使用してください。

パラメータ:
routeId - ルートID
戻り値:
int ルート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDataCountWithLocale

public int getRouteDataCountWithLocale(String routeId,
                                       String localeId)
                                throws WorkflowException
指定したロケールIDでルート情報の件数を取得します。

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
int ルート情報の件数
例外:
WorkflowException - ワークフロー例外クラス

createRouteData

public void createRouteData(RouteDataModel... models)
                     throws WorkflowException
ルート情報を新規作成します。

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

ワークフロー上で使用可能にするためにはルート詳細情報、および、各連携情報の作成が必要です。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteData

public void updateRouteData(RouteDataModel... models)
                     throws WorkflowException
ルート情報を更新します。

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

ワークフロー上で使用可能にするためにはルート詳細情報、および、各連携情報の更新が必要です。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRouteData

public void deleteRouteData(RouteDataModel... models)
                     throws WorkflowException
ルート情報を削除します。

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

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createRouteDataFamily

public void createRouteDataFamily(RouteDataModel... models)
                           throws WorkflowException
ルート情報と配下の情報を新規作成します。

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

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteDataFamily

public void updateRouteDataFamily(RouteDataModel... models)
                           throws WorkflowException
ルート情報と配下の情報を更新します。

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

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRouteDataFamily

public void deleteRouteDataFamily(RouteDataModel... models)
                           throws WorkflowException
ルート情報と配下の情報を削除します。

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

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createRouteDataWithAdjust

public void createRouteDataWithAdjust(RouteDataModel... models)
                               throws WorkflowException
ルート情報と配下の情報を自動調整し新規作成します。

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

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

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

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

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

異なるルートとしてバージョンのコピーを行う場合は、新しくルート情報を作成してルートIDを設定し、getRouteDetailDataFamily の結果を格納して本メソッドを呼び出してください。
同じルート内でバージョンのコピーを行う場合は、createRouteDetailDataWithAdjust を使用してください。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteDataWithAdjust

public void updateRouteDataWithAdjust(RouteDataModel... models)
                               throws WorkflowException
ルート情報と配下の情報を自動調整し更新します。

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

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

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

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

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

ルート詳細情報と配下の情報を更新しない場合は、updateRouteData を使用することでシステム負荷を抑えることができます。

パラメータ:
models - ルート情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataList

public RouteDetailDataModel[] getRouteDetailDataList(String routeId,
                                                     RouteDataSearchConditionInfo condition)
                                              throws WorkflowException
指定した検索条件でルート詳細情報を検索します。

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

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

アクセスロールの指定を行う場合は getRouteDetailDataListWithAccessRole を使用してください。

パラメータ:
routeId - ルートID
condition - ルート定義一覧情報検索条件情報
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListWithAccessRole

public RouteDetailDataModel[] getRouteDetailDataListWithAccessRole(String routeId,
                                                                   RouteDataSearchConditionInfo condition,
                                                                   String... accessRoles)
                                                            throws WorkflowException
指定した検索条件とアクセスロールでルート詳細情報を検索します。

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

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

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

パラメータ:
routeId - ルートID
condition - ルート定義一覧情報検索条件情報
accessRoles - アクセスロールの配列
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListWithLocale

public RouteDetailDataModel[] getRouteDetailDataListWithLocale(String routeId,
                                                               String localeId)
                                                        throws WorkflowException
指定したロケールIDでルート詳細情報を全バージョン分取得します。

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

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListFamilyWithLocale

public RouteDetailDataModel[] getRouteDetailDataListFamilyWithLocale(String routeId,
                                                                     String localeId)
                                                              throws WorkflowException
指定したロケールIDでルート詳細情報と配下の情報を全バージョン分取得します。

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

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListWithLocaleAndVersionStatuses

public RouteDetailDataModel[] getRouteDetailDataListWithLocaleAndVersionStatuses(String routeId,
                                                                                 String localeId,
                                                                                 String... versionStatuses)
                                                                          throws WorkflowException
指定したロケールIDとバージョンステータスでルート詳細情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報は取得しません。
ルート定義XMLファイル情報を除き、全ての情報を取得する場合は getRouteDetailDataListFamilyWithLocaleAndVersionStatuses を使用してください。
バージョンステータスには、ユーザ有効化・ユーザ無効化・システム無効化のいずれかを指定してください。

パラメータ:
routeId - ルートID
localeId - ロケールID
versionStatuses - バージョンステータスの配列
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListFamilyWithLocaleAndVersionStatuses

public RouteDetailDataModel[] getRouteDetailDataListFamilyWithLocaleAndVersionStatuses(String routeId,
                                                                                       String localeId,
                                                                                       String... versionStatuses)
                                                                                throws WorkflowException
指定したロケールIDとバージョンステータスでルート詳細情報と配下の情報を全バージョン分取得します。

ルート詳細情報配下の各連携情報、および、ルート定義XMLファイル情報の取得も行います。
システムの負荷が高くなる可能性がありますので、必要な場合にのみ使用してください。
バージョンステータスには、ユーザ有効化・ユーザ無効化・システム無効化のいずれかを指定してください。

パラメータ:
routeId - ルートID
localeId - ロケールID
versionStatuses - バージョンステータスの配列
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailData

public RouteDetailDataModel[] getRouteDetailData(String routeId,
                                                 String routeVersionId)
                                          throws WorkflowException
ルート詳細情報を全ロケール分取得します。

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

ロケールの指定を行う場合は getRouteDetailDataWithLocale を使用してください。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataWithLocale

public RouteDetailDataModel getRouteDetailDataWithLocale(String routeId,
                                                         String routeVersionId,
                                                         String localeId)
                                                  throws WorkflowException
指定したロケールIDでルート詳細情報を1件取得します。

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

該当するルート詳細情報が見つからなかった場合は、null を返却します。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
localeId - ロケールID
戻り値:
RouteDetailDataModel ルート詳細情報
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataFamily

public RouteDetailDataModel[] getRouteDetailDataFamily(String routeId,
                                                       String routeVersionId)
                                                throws WorkflowException
ルート詳細情報と配下の情報を全ロケール分取得します。

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

ロケールの指定を行う場合は getRouteDetailDataFamilyWithLocale を使用してください。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
戻り値:
RouteDetailDataModel[] ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataFamilyWithLocale

public RouteDetailDataModel getRouteDetailDataFamilyWithLocale(String routeId,
                                                               String routeVersionId,
                                                               String localeId)
                                                        throws WorkflowException
指定したロケールIDでルート詳細情報と配下の情報を1件取得します。

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

該当するルート詳細情報が見つからなかった場合は、null を返却します。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
localeId - ロケールID
戻り値:
RouteDetailDataModel ルート詳細情報
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListCount

public int getRouteDetailDataListCount(String routeId,
                                       RouteDataSearchConditionInfo condition)
                                throws WorkflowException
指定した検索条件でルート詳細情報の検索結果件数を取得します。

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

アクセスロールの指定を行う場合は getRouteDetailDataListCountWithAccessRole を使用してください。

パラメータ:
routeId - ルートID
condition - ルート定義一覧情報検索条件情報
戻り値:
int ルート詳細情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListCountWithAccessRole

public int getRouteDetailDataListCountWithAccessRole(String routeId,
                                                     RouteDataSearchConditionInfo condition,
                                                     String... accessRoles)
                                              throws WorkflowException
指定した検索条件とアクセスロールでルート詳細情報の検索結果件数を取得します。

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

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

パラメータ:
routeId - ルートID
condition - ルート定義一覧情報検索条件情報
accessRoles - アクセスロールの配列
戻り値:
int ルート詳細情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataListCountWithLocale

public int getRouteDetailDataListCountWithLocale(String routeId,
                                                 String localeId)
                                          throws WorkflowException
指定したロケールIDでルート詳細情報の全バージョン分の件数を取得します。

パラメータ:
routeId - ルートID
localeId - ロケールID
戻り値:
int ルート詳細情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataCount

public int getRouteDetailDataCount(String routeId,
                                   String routeVersionId)
                            throws WorkflowException
ルート詳細情報の全ロケール分の件数を取得します。

ロケールの指定を行う場合は getRouteDetailDataCountWithLocale を使用してください。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
戻り値:
int ルート詳細情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRouteDetailDataCountWithLocale

public int getRouteDetailDataCountWithLocale(String routeId,
                                             String routeVersionId,
                                             String localeId)
                                      throws WorkflowException
指定したロケールIDでルート詳細情報の件数を取得します。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
localeId - ロケールID
戻り値:
int ルート詳細情報の件数
例外:
WorkflowException - ワークフロー例外クラス

createRouteDetailData

public void createRouteDetailData(RouteDetailDataModel... models)
                           throws WorkflowException
ルート詳細情報を新規作成します。

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteDetailData

public void updateRouteDetailData(RouteDetailDataModel... models)
                           throws WorkflowException
ルート詳細情報を更新します。

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRouteDetailData

public void deleteRouteDetailData(RouteDetailDataModel... models)
                           throws WorkflowException
ルート詳細情報を削除します。

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

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

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createRouteDetailDataFamily

public void createRouteDetailDataFamily(RouteDetailDataModel... models)
                                 throws WorkflowException
ルート詳細情報と配下の情報を新規作成します。

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

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

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteDetailDataFamily

public void updateRouteDetailDataFamily(RouteDetailDataModel... models)
                                 throws WorkflowException
ルート詳細情報と配下の情報を更新します。

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

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

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

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

ワークフロー上で使用可能にするためには、データ矛盾のない各連携情報の登録と登録済みバージョンの期間調整が必要です。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRouteDetailDataFamily

public void deleteRouteDetailDataFamily(RouteDetailDataModel... models)
                                 throws WorkflowException
ルート詳細情報と配下の情報を削除します。

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

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

ルート詳細情報に指定したルート定義XMLファイルのパスは無視され、自動的に最新のパスを取得してルート定義XMLファイルの削除を行います。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

createRouteDetailDataWithAdjust

public void createRouteDetailDataWithAdjust(RouteDetailDataModel... models)
                                     throws WorkflowException
ルート詳細情報と配下の情報を自動調整し新規作成します。

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

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

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

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

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

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

同じルート内にバージョンのコピーを行う場合は、getRouteDetailDataFamily の処理結果に新しく採番したルートバージョンIDを設定して、本メソッドを呼び出してください。
異なるルートとしてバージョンのコピーを行う場合は、createRouteDataWithAdjust を使用してください。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRouteDetailDataWithAdjust

public void updateRouteDetailDataWithAdjust(RouteDetailDataModel... models)
                                     throws WorkflowException
ルート詳細情報と配下の情報を自動調整し更新します。

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

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

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

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

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

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

バージョン期間と配下の情報を更新しない場合は、updateRouteDetailData を使用することでシステム負荷を抑えることができます。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRouteDetailDataWithAdjust

public void deleteRouteDetailDataWithAdjust(RouteDetailDataModel... models)
                                     throws WorkflowException
ルート詳細情報と配下の情報を自動調整し削除します。

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

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

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

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

ワークフロー上でルート詳細情報を使用可能にするためには、登録済みバージョンの期間調整が必要です。
ルート詳細情報を削除する場合は本メソッドを使用してください。

パラメータ:
models - ルート詳細情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRoutePluginData

public RoutePluginDataModel[] getRoutePluginData(String routeId,
                                                 String routeVersionId)
                                          throws WorkflowException
ルートユーザ設定情報を取得します。

ノードの指定を行う場合は getRoutePluginDataWithNode を使用してください。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
戻り値:
RoutePluginDataModel[] ルートユーザ設定情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRoutePluginDataWithNode

public RoutePluginDataModel[] getRoutePluginDataWithNode(String routeId,
                                                         String routeVersionId,
                                                         String nodeId)
                                                  throws WorkflowException
指定したノードIDでルートユーザ設定情報を取得します。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
nodeId - ノードID
戻り値:
RoutePluginDataModel[] ルートユーザ設定情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRoutePluginDataCount

public int getRoutePluginDataCount(String routeId,
                                   String routeVersionId)
                            throws WorkflowException
ルートユーザ設定情報の全ノード、全ロケール分の件数を取得します。

ノードの指定を行う場合は getRoutePluginDataCountWithNode を使用してください。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
戻り値:
int ルートユーザ設定情報の件数
例外:
WorkflowException - ワークフロー例外クラス

getRoutePluginDataCountWithNode

public int getRoutePluginDataCountWithNode(String routeId,
                                           String routeVersionId,
                                           String nodeId)
                                    throws WorkflowException
指定したノードIDでルートユーザ設定情報の件数を取得します。

パラメータ:
routeId - ルートID
routeVersionId - ルートバージョンID
nodeId - ノードID
戻り値:
int ルートユーザ設定情報の件数
例外:
WorkflowException - ワークフロー例外クラス

createRoutePluginData

public void createRoutePluginData(RoutePluginDataModel... models)
                           throws WorkflowException
ルートユーザ設定情報を新規作成します。

パラメータ:
models - ルートユーザ設定情報の配列
例外:
WorkflowException - ワークフロー例外クラス

updateRoutePluginData

public void updateRoutePluginData(RoutePluginDataModel... models)
                           throws WorkflowException
ルートユーザ設定情報を更新します。

パラメータ:
models - ルートユーザ設定情報の配列
例外:
WorkflowException - ワークフロー例外クラス

deleteRoutePluginData

public void deleteRoutePluginData(RoutePluginDataModel... models)
                           throws WorkflowException
ルートユーザ設定情報を削除します。

パラメータ:
models - ルートユーザ設定情報の配列
例外:
WorkflowException - ワークフロー例外クラス

getRouteNodeData

public RouteNodeDataModel[] getRouteNodeData(RouteDetailDataModel model)
                                      throws WorkflowException
指定したルート詳細情報でルート情報ノード定義情報を取得します。

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

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

フロー情報管理マネージャ(FlowDataManager)にも同じ機能が提供されていますが、本メソッドではテンプレート置換ノードを展開せずに出力します。
テンプレート置換ノードを展開したルート情報ノード定義情報を取得する場合は、フロー情報管理マネージャを使用してください。

パラメータ:
model - ルート詳細情報
戻り値:
RouteNodeDataModel[] ルート情報ノード定義情報の配列
例外:
WorkflowException - ワークフロー例外クラス

beginFileControl

public void beginFileControl()
ルート定義のXMLファイルを操作する準備を行います。

ルート定義のXMLファイルを操作する前に本メソッドを呼び出すことで、createRouteDetailData、updateRouteDetailData、および、deleteRouteDetailData などで行われたXMLファイルの操作を元の状態に復元できるようになります。

本メソッドを呼び出さない場合でもXMLファイルの操作は行えますが、処理の途中でシステムに問題が発生した場合、ファイルの安全性は保証できません。


flushFileControl

public void flushFileControl()
                      throws WorkflowException
ルート定義のXMLファイルの変更を確定します。

beginFileControl を呼び出した後から本メソッドを呼び出した時点までのXMLファイルの変更を確定します。

本メソッドを呼び出す前に beginFileControl を呼び出してファイル操作の準備を行う必要があります。
beginFileControl を呼び出さずに本メソッドを呼び出した場合は例外が発生します。

本メソッドはXMLファイルの変更を確定しますが、データベースへの変更は確定しません。
データベースのトランザクションも同時に行っている場合、本メソッドを呼び出した後は速やかにデータベースへのコミットも行ってください。

例外:
WorkflowException - ワークフロー例外クラス

abortFileControl

public void abortFileControl()
                      throws WorkflowException
ルート定義のXMLファイルの操作を取消します。

beginFileControl を呼び出した後から本メソッドを呼び出した時点までのXMLファイルの変更を取消します。

本メソッドを呼び出す前に beginFileControl を呼び出してファイル操作の準備を行う必要があります。
beginFileControl を呼び出さずに本メソッドを呼び出した場合は例外が発生します。

本メソッドはXMLファイルの変更を取消しますが、データベースへの変更は取消しません。

例外:
WorkflowException - ワークフロー例外クラス

IM-Workflow

Copyright © 2000-2015 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.