IM-Workflow

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

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.CplMatterNode

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

案件(完了)ノードマネージャ。

完了した案件に対して、案件のノードに関連している情報を取得する際に使用します。
ノードの処理履歴、ノードの処理対象者や確認権限者、ノードの設定情報等の特定ノードに関連する情報を取得します。

本クラスでは主に「imw_t_cpl」で始まるトランザクション系の完了案件のデータベースのデータを取得します。
他、トランザクションファイルである「%StorageService%/storage/workflow/data/{%ログイングループID%}/transaction(標準設定の場合)」の配下にあるXMLファイルデータを取得します。

完了した案件に対して、案件関連情報を取得するには「CplMatter」を使用します。
完了した案件以外に、処理中の案件や過去案件のノード関連情報取得には「ActvMatterNode」、「ArcMatterNode」を利用してください。

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

入れ子のクラスの概要
 
クラス 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
 
コンストラクタの概要
CplMatterNode(String loginGroupId, String localeId, String systemMatterId)
          コンストラクタ。
 
メソッドの概要
 CnfmAuthUserModel[] getCnfmAuthUserList(String nodeId, SortConditionForAuthUser<CnfmAuthUserType> cond)
          完了案件の特定ノード確認処理権限者情報をすべて取得します。
 int getCnfmAuthUserListCount(String nodeId)
          完了案件の特定ノード確認処理権限者情報の件数を取得します。
 MatterNodeConfigModel getExecNodeConfig(String nodeId)
          完了案件のノード設定情報を取得します。
 ProcessTargetModel[] getExecProcessTargetList(String nodeId)
          完了案件に対して、処理中の最新フローから指定ノードの処理対象者プラグイン情報を取得します。
 ProcessTargetModel[] getMasterProcessTargetList(String nodeId)
          完了案件に対して、申請・起票時の初期フロー設定情報であるマスタフローから指定ノードの処理対象者プラグイン情報を取得します。
 MatterNodeModel getMatterNode(String nodeId)
          完了案件のノード情報を取得します。
 MatterProcessHistoryModel getProcessHistoryLatest(String nodeId)
          完了案件の特定ノードに対して、処理履歴の最新情報を取得します。
 MatterProcessHistoryModel[] getProcessHistoryList(String nodeId)
          完了案件の特定ノードに対して、処理履歴をすべて取得します。
 int getProcessHistoryListCount(String nodeId)
          完了案件の特定ノードに対して、処理履歴件数を取得します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CplMatterNode

public CplMatterNode(String loginGroupId,
                     String localeId,
                     String systemMatterId)
コンストラクタ。
引数で指定したログイングループID、ロケールID、システム案件IDで案件(完了)ノードマネージャを
新しく生成します。

パラメータ:
loginGroupId - ログイングループID
localeId - ロケールID
systemMatterId - システム案件ID
メソッドの詳細

getCnfmAuthUserList

public CnfmAuthUserModel[] getCnfmAuthUserList(String nodeId,
                                               SortConditionForAuthUser<CnfmAuthUserType> cond)
                                        throws WorkflowException
完了案件の特定ノード確認処理権限者情報をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」とパラメータで指定したノードIDで、
その案件の特定確認ノードで確認ができる権限者情報をすべて取得します。

検索条件を設定する為の引数である権限者情報ソート条件クラスの設定は必須です。
特に検索条件を設定する必要がない場合でもインスタンスを作成して設定する必要があります。
検索結果が存在しない場合にはサイズ0の空オブジェクトを返します。
ノードIDに「null」もしくは存在しないノードIDを指定した場合もサイズ0の空オブジェクトを返します。

検索結果を保存する「確認処理権限者情報の配列」はデータベーステーブル「imw_t_cpl_matter_confirm_user」のデータが設定されています。

CnfmAuthUserTypeに定義されているEnumをキーで検索条件を設定できます。詳しい使用方法は「SortConditionForAuthUser」を参照してください。
パラメータで指定する権限者情報ソート条件クラスはソートの条件のみ指定できます。ユーザを絞り込む為の条件としては使用できません。

特定ノードに限らず、案件の全確認権限者情報を取得するには「CplMatter.getCnfmAuthUserList(SortConditionForAuthUser)」を利用してください。

処理中の未完了案件の特定ノードの確認処理権限者情報を取得するには「ActvMatterNode.getCnfmAuthUserList(String, SortConditionForAuthUser)」を利用してください。

パラメータ:
nodeId - ノードID
cond - 権限者情報ソート条件
戻り値:
CnfmAuthUserModel[] 確認処理権限者情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

getCnfmAuthUserListCount

public int getCnfmAuthUserListCount(String nodeId)
                             throws WorkflowException
完了案件の特定ノード確認処理権限者情報の件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」とパラメータで指定したノードIDで、
その案件の特定ノードで確認ができる権限者の全人数を取得します。
本メソッドの検索対象データベーステーブルは「imw_t_cpl_matter_confirm_user」です。

特定ノードに限らず、案件の全確認権限者情報の件数を取得するには「CplMatter.getCnfmAuthUserListCount()」を利用してください。

処理中の未完了案件の特定ノード確認処理権限者情報の件数を取得するには「ActvMatterNode.getCnfmAuthUserListCount(String)」を利用してください。

パラメータ:
nodeId - ノードID
戻り値:
int 確認処理権限者情報件数
例外:
WorkflowException - ワークフロー例外の親クラス

getMatterNode

public MatterNodeModel getMatterNode(String nodeId)
                              throws WorkflowException
完了案件のノード情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」、
パラメータで指定したノードIDで取得したフローXMLファイル「flow.xml」から案件のノード情報を取得します。

検索結果を保存する「案件ノード情報」にはトランザクションXMLファイルの中で、最終結果の「flow.xml」の値が設定されます。
最終結果の「flow.xml」を取得するには、案件テーブル「imw_t_cpl_matter」の最終処理ID「last_process_id」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
標準設定の場合、取得対象の「flow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

パラメータで指定したノードIDに対して、存在有無のチェックは行なっていません。
指定したノードIDがフロー情報に存在しない場合には「null」が返却されます。

最終処理IDのデータベース検索で失敗した場合や、案件情報取得でコンストラクタに指定したシステム案件IDで検索結果が存在しない場合等、
ノード情報を取得する為のフローXML情報取得に失敗した場合には「WorkflowException」が発生します。

本メソッドでは、ノードに設定されている基本情報や親情報、画面関連情報等が取得できます。
詳細な設定情報をすべて取得するには「getExecNodeConfig(String)」を利用してください。

全てのノードに関して情報を取得するには、「CplMatter.getExecFlow()」や「CplMatter.getExecNodeListWithProcessType()」を利用してください。
2つのメソッドで取得できるノード情報は少し差異がありますので、詳細は各メソッドを参照してください。

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

パラメータ:
nodeId - ノードID
戻り値:
MatterNodeModel 案件ノード情報
例外:
WorkflowException - ワークフロー例外の親クラス

getExecNodeConfig

public MatterNodeConfigModel getExecNodeConfig(String nodeId)
                                        throws WorkflowException
完了案件のノード設定情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」、
パラメータで指定したノードIDで取得したフローXMLファイル「flow.xml」から案件のノード設定情報を取得します。

検索結果を保存する「案件ノード設定情報」にはトランザクションXMLファイルの中で、最終結果の「flow.xml」からノード設定情報を取得します。
最終結果の「flow.xml」を取得するには、案件テーブル「imw_t_cpl_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
標準設定の場合、取得対象の「flow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

パラメータで指定したノードIDに対して、存在有無のチェックは行なっていません。
指定したノードIDがフロー情報に存在しない場合には「null」が返却されます。

最終処理IDのデータベース検索で失敗した場合や、案件情報取得でコンストラクタに指定したシステム案件IDで検索結果が存在しない場合等、
ノード情報を取得する為のフローXML情報取得に失敗した場合には「WorkflowException」が発生します。

本メソッドでは、ノードの設定関連情報を全て取得します。
ノードの基本情報のみを取得するには「getMatterNode(String)」を利用してください。

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

パラメータ:
nodeId - ノードID
戻り値:
MatterNodeConfigModel 案件ノード設定情報
例外:
WorkflowException - ワークフロー例外の親クラス

getProcessHistoryList

public MatterProcessHistoryModel[] getProcessHistoryList(String nodeId)
                                                  throws WorkflowException
完了案件の特定ノードに対して、処理履歴をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」とパラメータで指定した「nodeId ノードID」で、
取得した特定ノードの処理履歴をすべて取得します。

検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル
「imw_t_cpl_matter_task」、「imw_t_cpl_matter_user」のデータが設定されています。

取得した結果が複数存在する場合は、処理時間順に返却します。
処理時間順のソートは「imw_t_cpl_matter_task」テーブルの「end_date」カラムで行なっています。

履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
指定したノードIDが下記の種別ではない場合等、検索結果が存在しない場合にはサイズ0の空オブジェクトを返却します。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

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

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

処理中の未完了案件のノード処理履歴を取得するには「ActvMatterNode.getProcessHistoryList(String)」を利用してください。
過去案件のノード処理履歴を取得するには「ArcMatterNode.getProcessHistoryList(String)」を利用してください。

パラメータ:
nodeId - ノードID
戻り値:
MatterProcessHistoryModel[] 案件処理履歴情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

getProcessHistoryListCount

public int getProcessHistoryListCount(String nodeId)
                               throws WorkflowException
完了案件の特定ノードに対して、処理履歴件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」とパラメータで指定した「nodeId ノードID」で、
取得した特定ノードの処理履歴の全件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_t_cpl_matter_task」、「imw_t_cpl_matter_user」です。
差戻しや引戻し等によって、複数回処理された場合には、複数履歴件数が取得されます。

履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
指定したノードIDが下記の種別ではない場合等、検索結果が存在しない場合は「0」が返却されます。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

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

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

パラメータ:
nodeId - ノードID
戻り値:
int 対象ノードの処理履歴件数
例外:
WorkflowException - ワークフロー例外の親クラス

getProcessHistoryLatest

public MatterProcessHistoryModel getProcessHistoryLatest(String nodeId)
                                                  throws WorkflowException
完了案件の特定ノードに対して、処理履歴の最新情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」とパラメータで指定した「nodeId ノードID」で、
取得した特定ノードの最新履歴を取得します。

検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル
「imw_t_cpl_matter_task」、「imw_t_cpl_matter_user」のデータが設定されています。

履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
指定したノードIDの最新の履歴データが複数存在することは通常ありえません。
指定したノードIDが下記の種別ではない場合等、検索結果が存在しない場合と検索結果が複数存在する場合には
エラーと判断して「null」を返却します。
 【ノード種別】
  ・申請ノード
  ・承認ノード
  ・動的承認ノード
  ・システムノード
 
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドは差戻しや引戻し等によって、複数回処理された場合でも、
「imw_t_cpl_matter_task」テーブルの「end_date」を基準で、最後に処理された最新データのみを取得します。
最新履歴(最後に処理された履歴)のみではなく、全ての履歴を取得する場合には「getProcessHistoryList(String)」を利用してください。

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

処理中の未完了案件のノード処理履歴を取得するには「ActvMatterNode.getProcessHistoryLatest(String)」を利用してください。
過去案件のノード処理履歴を取得するには「ArcMatterNode.getProcessHistoryLatest(String)」を利用してください。

パラメータ:
nodeId - ノードID
戻り値:
MatterProcessHistoryModel 案件処理履歴情報
例外:
WorkflowException - ワークフロー例外の親クラス

getExecProcessTargetList

public ProcessTargetModel[] getExecProcessTargetList(String nodeId)
                                              throws WorkflowException
完了案件に対して、処理中の最新フローから指定ノードの処理対象者プラグイン情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」、
パラメータで指定したノードIDで取得したフローXMLファイル「flow.xml」から指定ノード権限者プラグイン情報を取得します。

検索結果を保存する「処理対象者情報」にはトランザクションXMLファイルの中で、最終結果の「flow.xml」からのノード情報が設定されます。
最終結果の「flow.xml」を取得するには、案件テーブル「imw_t_cpl_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
値を用いて、トランザクションファイルディレクトリから取得します。
標準設定の場合、取得対象の「flow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/result/{%最終処理ID%}/flow.xml

パラメータで指定したノードIDに対して、存在有無のチェックは行なっていません。
指定したノードIDがフロー情報に存在しない場合にはサイズ0の空のオブジェクトが返却されます。

最終処理IDのデータベース検索で失敗した場合や、案件情報取得でコンストラクタに指定したシステム案件IDで検索結果が存在しない場合等、
ノード情報を取得する為のフローXML情報取得に失敗した場合には「WorkflowException」が発生します。

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

処理中の未完了案件の処理対象者プラグイン情報を取得するには「ActvMatterNode.getExecProcessTargetList(String)」を利用してください。

パラメータ:
nodeId - ノードID
戻り値:
ProcessTargetModel[] 処理対象者情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

getMasterProcessTargetList

public ProcessTargetModel[] getMasterProcessTargetList(String nodeId)
                                                throws WorkflowException
完了案件に対して、申請・起票時の初期フロー設定情報であるマスタフローから指定ノードの処理対象者プラグイン情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」、
パラメータで指定したノードIDで取得したマスタフローXMLファイル「masterflow.xml」から指定ノード権限者プラグイン情報を取得します。

検索結果を保存する「処理対象者情報」にはトランザクションXMLファイルの中で、「masterflow.xml」の値が設定されます。
標準設定の場合、取得対象の「masterflow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml
※未完了案件用のマスタフロー取得メソッドと完了案件用のマスタフロー取得メソッドは同じファイルを参照します。

パラメータで指定したノードIDに対して、存在有無のチェックは行なっていません。
指定したノードIDがフロー情報に存在しない場合にはサイズ0の空のオブジェクトが返却されます。

最終処理IDのデータベース検索で失敗した場合や、案件情報取得でコンストラクタに指定したシステム案件IDで検索結果が存在しない場合等、
ノード情報を取得する為のマスタフローXML情報取得に失敗した場合には「WorkflowException」が発生します。

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

処理中の未完了案件のマスタ情報からの処理対象者プラグイン情報を取得するには「ActvMatterNode.getMasterProcessTargetList(String)」を利用してください。

パラメータ:
nodeId - ノードID
戻り値:
ProcessTargetModel[] 処理対象情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

IM-Workflow

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