IM-Workflow

jp.co.intra_mart.foundation.workflow.application.general
クラス ArcMatter

java.lang.Object
  上位を拡張 jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase
      上位を拡張 jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
          上位を拡張 jp.co.intra_mart.foundation.workflow.application.general.ArcMatter

public class ArcMatter
extends jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

過去案件マネージャ。

アーカイブ処理で退避させた過去案件に関連している情報を取得する際に使用します。
案件参照者情報、案件情報、処理履歴、関連するXMLファイル情報等、複数ノードに関連する情報を取得します。
本クラスでは主に「imw_ayyyymm_」で始まるトランザクション系の過去案件のデータベースデータを取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
他、過去案件ファイルである「%StorageService%/storage/workflow/data/{%ログイングループID%}/archive(標準設定の場合)」の配下にあるXMLファイルデータを取得します。

過去案件で特定ノード関連情報を取得するには「ArcMatterNode」を使用します。
過去案件以外に、未完了案件や完了案件に対しては「ActvMatter」、「CplMatter」を利用してください。
一時保存案件の情報は「TempSaveMatter」から取得できます。

導入されたバージョン:
7.2
関連項目:
ArcMatterNode, ActvMatter, CplMatter, TempSaveMatter

入れ子のクラスの概要
 
クラス jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase から継承された入れ子のクラス/インタフェース
jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql
 
フィールドの概要
 
クラス jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase から継承されたフィールド
manager
 
コンストラクタの概要
ArcMatter(String loginGroupId, String localeId, String systemMatterId, String archiveMonth)
          コンストラクタ。
 
メソッドの概要
 MatterAttachFileModel[] getAttachFileList()
          過去案件の処理時に添付したファイルの情報をすべて取得します。
 int getAttachFileListCount()
          過去案件の処理時に添付したファイルの情報の件数を取得します。
 MatterCnfmHistoryModel[] getCnfmHistoryList()
          過去案件の確認履歴をすべて取得します。
 int getCnfmHistoryListCount()
          過去案件の確認履歴の件数を取得します。
 MatterFlowModel getExecFlow()
          過去案件の最終処理結果フロー情報「flow.xml」を取得します。
 String getExecFlowXML()
          過去案件の最終処理結果フロー情報「flow.xml」を文字列で取得します。
 MatterNodeWithProcessTypeModel[] getExecNodeListWithProcessType()
          過去案件の最終処理結果フロー情報「flow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
 MatterFlowModel getMasterFlow()
          過去案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」情報を取得します。
 String getMasterFlowXML()
          完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」を文字列で取得します。
 MatterNodeWithProcessTypeModel[] getMasterNodeListWithProcessType()
          過去案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
 ArcMatterModel getMatter()
          過去案件情報を取得します。
 UserMatterPropertyModel getMatterProperty(String key)
          過去案件の特定のユーザデータ案件プロパティ情報を取得します。
 UserMatterPropertyModel[] getMatterPropertyList()
          過去案件のユーザデータ案件プロパティ情報をすべて取得します。
 int getMatterPropertyListCount()
          過去案件のユーザデータ案件プロパティ情報の件数を取得します。
 NodeProgressModel[] getNodeProgressList()
          過去案件の進捗ファイル情報「progress.xml」を取得します。
 MatterProcessHistoryModel[] getProcessHistoryLatestList()
          過去案件の処理履歴の最新情報を取得します。
 MatterProcessHistoryModel[] getProcessHistoryList()
          過去案件の処理履歴をすべて取得します。
 int getProcessHistoryListCount()
          過去案件の処理履歴件数を取得します。
 String[] getRefAuthUserList()
          過去案件の参照権限者をすべて取得します。
 int getRefAuthUserListCount()
          過去案件の参照権限者の件数を取得します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ArcMatter

public ArcMatter(String loginGroupId,
                 String localeId,
                 String systemMatterId,
                 String archiveMonth)
コンストラクタ。
引数で指定したログイングループID、ロケールID、システム案件ID、アーカイブ年月(yyyyMM)で
過去案件マネージャを新しく生成します。

パラメータ:
loginGroupId - ログイングループID
localeId - ロケールID
systemMatterId - システム案件ID
archiveMonth - アーカイブ年月(yyyyMM)
メソッドの詳細

getMatter

public ArcMatterModel getMatter()
                         throws WorkflowException
過去案件情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」、「localeId ロケールID」と「archiveMonth アーカイブ年月」で案件情報を取得します。
検索結果を保存する「過去案件情報」にはデータベーステーブル
「imw_ayyyymm_matter」と「imw_ayyyymm_matter_locale」のデータが設定されます。
モデル内の「ユーザデータ案件プロパティ」には「imw_ayyyymm_maatter_user_data」のデータが設定されます。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

1つのシステムで1つのロケールに対して同じシステム案件IDが2個以上存在するのは不可能です。
検索の結果、2個以上のデータが取得された場合には、エラーと判断して、「null」を返却します。
検索した結果がない場合でも「null」を返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にも「null」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

処理中の未完了案件情報を取得するには「ActvMatter.getMatter()」を利用してください。
完了案件情報を取得するには「CplMatter.getMatter()」を利用してください。

戻り値:
ArcMatterModel 過去案件情報
例外:
WorkflowException - ワークフロー例外の親クラス

getProcessHistoryList

public MatterProcessHistoryModel[] getProcessHistoryList()
                                                  throws WorkflowException
過去案件の処理履歴をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「archiveMonth アーカイブ年月」で
取得した案件のノード処理履歴をすべて取得します。
履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル
「imw_ayyyymm_matter_task」のデータが設定されています。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

取得した結果が複数存在する場合に結果のソート処理は行なっていません。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドは差戻しや引戻し等によって、1つのノードが複数回処理された場合には、1つのノードに対して複数履歴が取得されます。
各ノードに対して、最新履歴(最後に処理された履歴)のみ取得する場合には「getProcessHistoryLatestList()」を利用してください。

全ノードデータではなく、1つの特定ノードに対して履歴を取得する場合には、「ArcMatterNode.getProcessHistoryList(String)」を利用してください。

処理中の未完了案件の処理履歴を取得するには「ActvMatter.getProcessHistoryList()」を利用してください。
完了案件の処理履歴を取得するには「CplMatter.getProcessHistoryList()」を利用してください。

※このメソッドで取得する履歴にはキャンセルステータスや復元ステータス等も全て含めています。
※標準履歴詳細画面で使用しているタグリブ「workflow:workflowMatterHistory」の出力結果とは異なります。

戻り値:
MatterProcessHistoryModel[] 案件処理履歴情報の配列
例外:
WorkflowException - ワークフロー例外

getProcessHistoryListCount

public int getProcessHistoryListCount()
                               throws WorkflowException
過去案件の処理履歴件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「archiveMonth アーカイブ年月」で
取得した案件のノード処理履歴の全件数を取得します。
履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
本メソッドの検索対象データベーステーブルは「imw_ayyyymm_matter_task」です。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
差戻しや引戻し等によって、1つのノードが複数回処理された場合には、1つのノードに対して複数履歴件数が取得されます。

コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「0」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

全ノードデータではなく、1つの特定ノードに対して履歴件数を取得する場合には、「ArcMatterNode.getProcessHistoryListCount(String)」を利用してください。

処理中の未完了案件の処理履歴を取得するには「ActvMatter.getProcessHistoryListCount()」を利用してください。
完了案件の処理履歴を取得するには「CplMatter.getProcessHistoryListCount()」を利用してください。

戻り値:
int 案件処理履歴情報件数
例外:
WorkflowException - ワークフロー例外

getProcessHistoryLatestList

public MatterProcessHistoryModel[] getProcessHistoryLatestList()
                                                        throws WorkflowException
過去案件の処理履歴の最新情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「archiveMonth アーカイブ年月」で
取得した案件のノードの最新履歴を取得します。
履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル「imw_ayyyymm_matter_task」のデータが設定されています。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドは差戻しや引戻し等によって、1つのノードが複数回処理された場合には、
「imw_ayyyymm_matter_task」テーブルの「end_date」を基準で、1つのノードに対して最後に処理された最新履歴データのみを取得します。

各ノードに対して、最新履歴(最後に処理された履歴)のみではなく、全ての履歴を取得する場合には「getProcessHistoryList()」を利用してください。

全ノードデータではなく、1つの特定ノードに対して最新履歴を取得する場合には、「ArcMatterNode.getProcessHistoryLatest(String)」を利用してください。

処理中の未完了案件の処理履歴を取得するには「ActvMatter.getProcessHistoryLatestList()」を利用してください。
過去案件の処理履歴を取得するには「CplMatter.getProcessHistoryLatestList()」を利用してください。

※このメソッドで取得する履歴にはキャンセルステータスや復元ステータス等も全て含めています。
※標準フロー詳細画面で使用しているタグリブ「workflow:workflowMatterResult」の出力結果とは異なります。

戻り値:
MatterProcessHistoryModel[] 案件処理履歴情報の配列
例外:
WorkflowException - ワークフロー例外

getCnfmHistoryList

public MatterCnfmHistoryModel[] getCnfmHistoryList()
                                            throws WorkflowException
過去案件の確認履歴をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件の確認履歴を取得します。

検索結果を保存する「案件確認履歴情報の配列」はデータベーステーブル
「imw_ayyyymm_matter_confirm」のデータが設定されています。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、
過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

確認ノードが複数ある場合は、全確認ノード分取得します。
取得結果は「imw_t_cpl_matter_confirm」テーブルの確認時間「confirm_date」順でソートされます。

処理中の未完了案件の確認履歴を取得するには「ActvMatter.getCnfmHistoryList()」を利用してください。
過去案件の確認履歴を取得するには「CplMatter.getCnfmHistoryList()」を利用してください。

戻り値:
MatterCnfmHistoryModel[] 案件確認履歴の配列
例外:
WorkflowException - ワークフロー例外

getCnfmHistoryListCount

public int getCnfmHistoryListCount()
                            throws WorkflowException
過去案件の確認履歴の件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件の確認履歴件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_ayyyymm_matter_confirm」です。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
確認ノードが複数ある場合は、全確認ノード分の件数を取得します。

コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「0」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

処理中の未完了案件の確認履歴件数を取得するには「ActvMatter.getCnfmHistoryListCount()」を利用してください。
完了案件の確認履歴件数を取得するには「CplMatter.getCnfmHistoryListCount()」を利用してください。

戻り値:
int 案件確認履歴件数
例外:
WorkflowException - ワークフロー例外

getAttachFileList

public MatterAttachFileModel[] getAttachFileList()
                                          throws WorkflowException
過去案件の処理時に添付したファイルの情報をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件の添付ファイル情報を取得します。

検索結果を保存する「案件添付ファイル情報の配列」はデータベーステーブル
「imw_ayyyymm_matter_attach_file」のデータが設定されています。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、
過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

添付ファイルは案件単位で管理されます。
処理時に添付したファイルが複数存在する場合に取得結果のソート処理は行なっていません。
標準設定の場合、添付ファイルは下記に保存されます。
{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/attachfile

処理中の未完了案件の添付したファイルの情報を取得するには「ActvMatter.getAttachFileList()」を利用してください。
完了案件の添付したファイルの情報を取得するには「CplMatter.getAttachFileList()」を利用してください。

戻り値:
MatterAttachFileModel[] 案件添付ファイル情報の配列
例外:
WorkflowException - ワークフロー例外

getAttachFileListCount

public int getAttachFileListCount()
                           throws WorkflowException
過去案件の処理時に添付したファイルの情報の件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件の添付ファイル情報件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_ayyyymm_matter_attach_file」です。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「0」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

標準設定の場合、本メソッドで取得する件数は下記に保存されているファイル件数と一致します。
{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/attachfile

処理中の未完了案件の添付したファイル件数を取得するには「ActvMatter.getAttachFileListCount()」を利用してください。
完了案件の添付したファイル件数を取得するには「CplMatter.getAttachFileListCount()」を利用してください。

戻り値:
int 案件添付ファイル情報件数
例外:
WorkflowException - ワークフロー例外

getMatterProperty

public UserMatterPropertyModel getMatterProperty(String key)
                                          throws WorkflowException
過去案件の特定のユーザデータ案件プロパティ情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件に登録されているユーザデータID、
パラメータに指定した「key 案件プロパティキー」でユーザデータ情報を取得します。

検索結果を保存する「ユーザデータ案件プロパティ情報の配列」はデータベーステーブル
「imw_ayyyymm_matter_user_data」のデータが設定されています。
ユーザデータテーブル「imw_ayyyymm_matter_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_ayyyymm_matter」の「USER_DATA_ID」カラムから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

同じユーザデータIDに重複するキーは存在できません。検索の結果、情報が取得出来なかった場合、
もしくは2個以上のデータが取得された場合には、エラーと見なして、「null」を返却します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にも「null」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

特定の案件プロパティキーに限らず、案件に紐づいている全てのユーザデータを取得するには「getMatterPropertyList()}」を利用してください。

処理中の未完了案件の特定のユーザデータ案件プロパティ情報を取得するには「ActvMatter.getMatterProperty(String)」を利用してください。
完了案件の特定のユーザデータ案件プロパティ情報を取得するには「CplMatter.getMatterProperty(String)」を利用してください。

システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報を取得するには
UserArcMatterPropertyValue.getMatterProperty(String, String)」を利用してください。

パラメータ:
key - 案件プロパティキー
戻り値:
UserMatterPropertyModel ユーザデータ案件プロパティ情報
例外:
WorkflowException - ワークフロー例外

getMatterPropertyList

public UserMatterPropertyModel[] getMatterPropertyList()
                                                throws WorkflowException
過去案件のユーザデータ案件プロパティ情報をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件に登録されているユーザデータIDで、
案件に紐づいているユーザデータ情報を全て取得します。

検索結果を保存する「ユーザデータ案件プロパティ情報の配列」はデータベーステーブル
「imw_ayyyymm_matter_user_data」のデータが設定されています。
ユーザデータテーブル「imw_ayyyymm_matter_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_ayyyymm_matter」の「USER_DATA_ID」カラムから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

全てのユーザデータではなく、特定の案件プロパティを取得するには「getMatterProperty(String)}」を利用してください。

処理中の未完了案件のユーザデータ案件プロパティ情報を全て取得するには「ActvMatter.getMatterPropertyList()」を利用してください。
完了案件のユーザデータ案件プロパティ情報を全て取得するには「CplMatter.getMatterPropertyList()」を利用してください。

システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報を取得するには
UserArcMatterPropertyValue.getMatterPropertyList(String)」を利用してください。

戻り値:
UserMatterPropertyModel[] ユーザデータ案件プロパティ情報の配列
例外:
WorkflowException - ワークフロー例外

getMatterPropertyListCount

public int getMatterPropertyListCount()
                               throws WorkflowException
過去案件のユーザデータ案件プロパティ情報の件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で取得した案件に登録されているユーザデータIDで、
案件に紐づいているユーザデータ情報の件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_ayyyymm_matter_user_data」です。
ユーザデータテーブル「imw_ayyyymm_matter_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_ayyyymm_matter」の「USER_DATA_ID」カラムから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「0」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

処理中の未完了案件のユーザデータ案件プロパティ情報の件数を取得するには「ActvMatter.getMatterPropertyListCount()」を利用してください。
完了案件のユーザデータ案件プロパティ情報の件数を取得するには「CplMatter.getMatterPropertyListCount()」を利用してください。

システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報件数を取得するには
UserArcMatterPropertyValue.getMatterPropertyListCount(String)」を利用してください。

戻り値:
int ユーザデータ案件プロパティ情報件数
例外:
WorkflowException - ワークフロー例外

getExecFlow

public MatterFlowModel getExecFlow()
                            throws WorkflowException
過去案件の最終処理結果フロー情報「flow.xml」を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」での該当案件の最終処理結果フロー情報「flow.xml」のXML内容を取得します。

最終処理結果の「flow.xml」を取得するには、案件テーブル「imw_ayyyymm_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
取得結果「案件フロー情報」には、標準の設定の場合は、下記の「flow.xml」の内容が設定されます。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

案件フロー情報「MatterFlowModel」に設定される案件ノード情報「MatterNodeModel」は開始ノードから終了ノードまでの順でソートされます。
分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。

コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「null」が返却されます。 コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合は「WorkflowException」が発生します。

本メソッドで取得する「MatterFlowModel 案件フロー情報」にはそのノードで実行可能な処理種別情報は含まれていませんが、
ノードが展開されたノードの場合(横・縦配置ノードの子ノード)にその親ノードのタイプやIDは取得できます。
(1つのノードに対して同様の情報は「ArcMatterNode.getMatterNode(String)」から取得できます。)
そのノードで実行可能な処理種別情報が必要な場合には、「getExecNodeListWithProcessType()」を利用してください。

フローXMLを「案件フロー情報」モデルではなく、XML文字列で取得するには「getExecFlowXML()」を利用してください。

処理中の未完了案件のフロー情報を取得するには「ActvMatter.getExecFlow()」を利用してください。
完了案件のフロー情報を取得するには「CplMatter.getExecFlow()」を利用してください。

戻り値:
MatterFlowModel 案件フロー情報
例外:
WorkflowException - ワークフロー例外

getExecFlowXML

public String getExecFlowXML()
                      throws WorkflowException
過去案件の最終処理結果フロー情報「flow.xml」を文字列で取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件の最終処理結果フロー情報「flow.xml」のXML内容を文字列で取得します。

最終処理結果の「flow.xml」を取得するには、案件テーブル「imw_ayyyymm_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
標準の設定の場合は、取得対象の「flow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「null」が返却されます。
コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合は「WorkflowException」が発生します。

フローXMLを内容を文字列ではなく、オブジェクトで取得するには「getExecFlow()」を利用してください。

処理中の未完了案件のフロー情報を文字列で取得するには「ActvMatter.getExecFlowXML()」を利用してください。
完了案件のフロー情報を文字列で取得するには「CplMatter.getExecFlowXML()」を利用してください。

戻り値:
String XML文字列
例外:
WorkflowException - ワークフロー例外

getMasterFlow

public MatterFlowModel getMasterFlow()
                              throws WorkflowException
過去案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件のマスタフロー情報「masterflow.xml」のXML内容を取得します。

取得結果「案件フロー情報」には、標準の設定の場合は、下記の「masterflow.xml」の内容が設定されます。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml

案件フロー情報「MatterFlowModel」に設定される案件ノード情報「MatterNodeModel」は開始ノードから終了ノードまでの順でソートされます。
分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。

本メソッドはデータベースに直接関係ある処理ではないので、コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、
過去案件テーブルが存在有無のチェックは行なっていません。
コンストラクタに指定したシステム案件IDとアーカイブ年月で案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。

本メソッドで取得する「MatterFlowModel 案件フロー情報」にはそのノードで実行可能な処理種別情報は含まれていませんが、
ノードが展開されたノードの場合(横・縦配置ノードの子ノード)にその親ノードのタイプやIDは取得できます。
そのノードで実行可能な処理種別情報が必要な場合には、「getMasterNodeListWithProcessType()」を利用してください。

フローXMLを「案件フロー情報」モデルではなく、XML文字列で取得するには「getMasterFlowXML()」を利用してください。

処理中の未完了案件のマスタフロー情報を取得するには「ActvMatter.getMasterFlow()」を利用してください。
完了案件のマスタフロー情報を取得するには「CplMatter.getMasterFlow()」を利用してください。

戻り値:
MatterFlowModel 案件フロー情報
例外:
WorkflowException - ワークフロー例外

getMasterFlowXML

public String getMasterFlowXML()
                        throws WorkflowException
完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」を文字列で取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件のマスタフロー情報「masterflow.xml」のXML内容を文字列で取得します。

標準設定の場合、取得対象の「masterflow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml

本メソッドはデータベースに直接関係ある処理ではないので、コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、
過去案件テーブルが存在有無のチェックは行なっていません。
コンストラクタに指定したシステム案件IDとアーカイブ年月で案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。

フローXMLを内容を文字列ではなく、オブジェクトで取得するには「getMasterFlow()」を利用してください。

処理中の未完了案件のマスタフロー情報を取得するには「ActvMatter.getMasterFlowXML()」を利用してください。
完了案件のマスタフロー情報を取得するには「CplMatter.getMasterFlowXML()」を利用してください。

戻り値:
String XML文字列
例外:
WorkflowException - ワークフロー例外の親クラス

getExecNodeListWithProcessType

public MatterNodeWithProcessTypeModel[] getExecNodeListWithProcessType()
                                                                throws WorkflowException
過去案件の最終処理結果フロー情報「flow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件の最終処理結果フロー情報「flow.xml」のXML内容を取得し、ノード情報を取得します。

最新の「flow.xml」を取得するには、案件テーブル「imw_ayyyymm_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
取得結果「案件フロー情報」には、標準の設定の場合は、下記の「flow.xml」の内容が設定されます。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

取得結果である「MatterNodeWithProcessTypeModel[] 案件ノード情報」は開始ノードから終了ノードまでの順でソートされます。
分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。

コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にはサイズ0の空オブジェクトを返却されます。
コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合は「WorkflowException」が発生します。

ノード情報ではなく、フロー情報を取得するには「getExecFlow()」を利用してください。
getExecFlow()」で取得できるノード情報にはノードで実行可能な処理種別情報は含まれていませんが、
ノードが展開されたノードの場合(横・縦配置ノードの子ノード)にその親ノードのタイプやIDは取得できます。
1つのノードに対して同様の情報は「ArcMatterNode.getExecNodeConfig(String)」から取得できます。
ArcMatterNode.getExecNodeConfig(String)」で取得できる情報には、処理種別以外の全てのノード設定情報が含まれています。

処理中の最新フロー情報ではなく、申請・起票時のマスタフローからノード情報を取得するには「getMasterNodeListWithProcessType()」を利用してください。

処理中の未完了案件のノード情報を取得するには「ActvMatter.getExecNodeListWithProcessType()」を利用してください。
過去案件のノード情報を取得するには「CplMatter.getExecNodeListWithProcessType()」を利用してください。

戻り値:
MatterNodeWithProcessTypeModel[] 案件ノード情報(ノード別処理種別含む)の配列
例外:
WorkflowException - ワークフロー例外の親クラス

getMasterNodeListWithProcessType

public MatterNodeWithProcessTypeModel[] getMasterNodeListWithProcessType()
                                                                  throws WorkflowException
過去案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件のマスタフロー情報「masterflow.xml」のXML内容を取得し、ノード情報を取得します。

標準設定の場合、取得対象の「masterflow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml

取得結果である「MatterNodeWithProcessTypeModel[] 案件ノード情報」は開始ノードから終了ノードまでの順でソートされます。
分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。

コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合はサイズ0の空オブジェクトを返却します。
コンストラクタに指定したシステム案件IDとアーカイブ年月で案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。

ノード情報ではなく、マスタフロー情報を取得するには「getMasterFlow()」を利用してください。
getMasterFlow()」で取得できるノード情報にはノードで実行可能な処理種別情報は含まれていませんが、
ノードが展開されたノードの場合(横・縦配置ノードの子ノード)にその親ノードのタイプやIDは取得できます。

マスタフローではなく、実行中の最新フローからノード情報を取得するには「getExecNodeListWithProcessType()」を利用してください。

処理中の未案件のノード情報を取得するには「ActvMatter.getMasterNodeListWithProcessType()」を利用してください。
過去案件のノード情報を取得するには「CplMatter.getMasterNodeListWithProcessType()」を利用してください。

戻り値:
MatterNodeWithProcessTypeModel[] 案件ノード情報(ノード別処理種別含む)の配列
例外:
WorkflowException - ワークフロー例外の親クラス

getRefAuthUserList

public String[] getRefAuthUserList()
                            throws WorkflowException
過去案件の参照権限者をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「archiveMonth アーカイブ年月」で
過去案件参照還元者情報を全て取得します。

検索結果にはデータベーステーブル「imw_ayyyymm_matter_auth_user」の権限者カラムの「AUTH_USER_CODE」が設定されています。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

検索結果が存在しない場合にはサイズ0の空オブジェクトを返します。
コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合にもサイズ0の空オブジェクトを返します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドで取得対象になっている「imw_ayyyymm_matter_auth_user」の権限者データの作成は、
標準処理では、ログイングループパラメータの「archive-proc-listener-path」で設定している案件退避リスナー
(標準設定では「jp.co.intra_mart.system.workflow.listener.impl.WorkflowMatterArchiveStandardListener」)によって行なっています。
標準設定では、CplMatter.getProcessHistoryList()で取得した結果の権限者情報が設定されます。

戻り値:
String[] 参照権限者コードの配列
例外:
WorkflowException - ワークフロー例外の親クラス

getRefAuthUserListCount

public int getRefAuthUserListCount()
                            throws WorkflowException
過去案件の参照権限者の件数を取得します。
コンストラクタに指定した「systemMatterId システム案件ID」と「archiveMonth アーカイブ年月」で
過去案件参照還元者件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_ayyyymm_matter_auth_user」です。 テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。

コンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合には「0」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

戻り値:
int 参照権限者件数
例外:
WorkflowException - ワークフロー例外の親クラス

getNodeProgressList

public NodeProgressModel[] getNodeProgressList()
                                        throws WorkflowException
過去案件の進捗ファイル情報「progress.xml」を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と
「archiveMonth アーカイブ年月」で該当案件の最終処理結果進捗情報「progress.xml」のXML内容を取得します。

最終処理結果の「progress.xml」を取得するには、案件テーブル「imw_ayyyymm_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
テーブル名に含まれる「yyyymm」はコンストラクタで指定する「archiveMonth アーカイブ年月(yyyyMM)」です。
取得結果「ノード進捗情報」には、標準の設定の場合は、下記の「progress.xml」の内容が設定されます。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/archive/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/progress.xml

取得結果である「NodeProgressModel[] ノード進捗情報の配列」のソート順は進捗情報ファイル「progress.xml」の解析順になります。明確なソート処理は行なっていません。

本メソッドはコンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在有無のチェックは行なっていません。
コンストラクタで指定した「archiveMonth アーカイブ年月(yyyyMM)」に対して、過去案件テーブルが存在しない場合、
コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「progress.xml」情報取得に失敗した場合等、進捗XML情報が取得できなかった場合は「WorkflowException」が発生します。

処理中の未完了案件の進捗ファイル情報を取得するには「ActvMatter.getNodeProgressList()」を利用してください。
過去案件の進捗ファイル情報を取得するには「CplMatter.getNodeProgressList()」を利用してください。

戻り値:
NodeProgressModel[] ノード進捗情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

IM-Workflow

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