ActvMatter (javadoc-all-dev 8.0.0 API)

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

```
public class ActvMatter
extends jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
```
案件（未完了）マネージャ。

処理中である未完了案件に対して、案件に関連している情報を取得する際に使用します。
案件操作権限者情報、確認権限者、案件情報、処理履歴、処理中のノードのリスト、関連するXMLファイル情報等、
複数ノードに関連する情報を取得します。

本クラスでは主に「imw_t_actv」で始まるトランザクション系の未完了案件のデータベースのデータを取得します。
処理中の案件で特定ノード関連情報を取得するには「ActvMatterNode」を使用します。
未完了案件以外に、完了された案件や過去案件に対しては「CplMatter」、「ArcMatter」を利用してください。
一時保存案件の情報は「TempSaveMatter」から取得できます。

導入されたバージョン:

7.2

バージョン:

8.0.34

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース 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.api.database.AbstractListDaoBase
  localeId, userCd
- クラスから継承されたフィールド jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase
  COMBINE_AND, COMMA, INVALID_FIELD, LEFT_PARENTHESIS, loginGroupId, manager, PREPARESTMT_BIND_LIST_KEY, PREPARESTMT_SQL_KEY, QUESTION, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, VALID_FIELD_NOT_REQUIRED, VALID_FIELD_REQUIRED, VALID_PRIMARY_FIELD

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`ActvMatter(String systemMatterId)` コンストラクタ。
`ActvMatter(String localeId, String systemMatterId)` コンストラクタ。
`ActvMatter(String loginGroupId, String localeId, String systemMatterId)` 非推奨です。 `ActvMatter(String, String)` を使用してください。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`MatterActvNodeModel[]`	`getActvNodeList()` 未完了案件の処理中のノード情報をすべて取得します。
`MatterActvNodeModel[]`	`getActvNodeListWithoutRouteInfo()` 未完了案件の処理中のノード情報をすべて取得します。
`SessionScopeStorage`	`getAttachFile(String systemFileName)` 指定した添付ファイルのセッションスコープストレージを取得します。
`MatterAttachFileModel[]`	`getAttachFileList()` 未完了案件の処理時に添付したファイルの情報をすべて取得します。
`int`	`getAttachFileListCount()` 未完了案件の処理時に添付したファイルの情報の件数を取得します。
`CnfmAuthUserModel[]`	`getCnfmAuthUserList(SortConditionForAuthUser<CnfmAuthUserType> cond)` 未完了案件の確認処理権限者情報をすべて取得します。
`int`	`getCnfmAuthUserListCount()` 未完了案件の確認処理権限者情報の件数を取得します。
`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」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
`ActvMatterModel`	`getMatter()` 未完了案件情報を取得します。
`MatterHandleAuthUserModel`	`getMatterHandleAuth(String matterHandleUserCd)` 未完了案件の案件操作権限情報を取得します。
`MatterHandleAuthUserModel[]`	`getMatterHandleAuthList(SortConditionForAuthUser<MatterHandleAuthUserType> cond)` 未完了案件の案件操作権限情報をすべて取得します。
`int`	`getMatterHandleAuthListCount()` 未完了案件の案件操作権限情報の件数を取得します。
`UserMatterPropertyModel`	`getMatterProperty(String key)` 未完了案件の特定のユーザデータ案件プロパティ情報を取得します。
`UserMatterPropertyModel[]`	`getMatterPropertyList()` 未完了案件のユーザデータ案件プロパティ情報をすべて取得します。
`int`	`getMatterPropertyListCount()` 未完了案件のユーザデータ案件プロパティ情報の件数を取得します。
`NodeProgressModel[]`	`getNodeProgressList()` 処理中の未完了案件の進捗ファイル情報「progress.xml」を取得します。
`MatterProcessHistoryModel[]`	`getProcessHistoryLatestList()` 処理中の未完了案件の処理履歴の最新情報を取得します。
`MatterProcessHistoryModel[]`	`getProcessHistoryList()` 処理中の未完了案件の処理履歴をすべて取得します。
`int`	`getProcessHistoryListCount()` 処理中の未完了案件の処理履歴件数を取得します。
`protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql`	`getPropertyTable()` 案件プロパティ（ユーザデータ）テーブルを取得します。
`protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql`	`getSearchMainTable()` 検索メイン用テーブルを取得します。

クラスから継承されたメソッド jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
appendOrderCondition, checkJoinFlowGrpQuery, checkJoinFlowGrpQueryNoMatterProp, createPreSQL, executeCount, executeCount, executeCount, executeCount, executeCountForEachFlow, executeSearch, executeSearch, executeSearch, executeSearch, isDistinctSearch, modifyFinalCompleteSQL, modifyFinalSearchSQL

クラスから継承されたメソッド jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase
addOptionClause, bindingPreStatement, checkField, checkWorkflowDaoMappingClass, closeConnection, closeResultSet, closeStatement, convertLimitSql, createResultObject, createResultObject, createResultObject, getColumnName, getConnection, getDbType, getEscapedValue, getFieldType, getSQLString

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ActvMatter
```
public ActvMatter(String systemMatterId)
```
    コンストラクタ。
    引数で指定したシステム案件IDで案件（未完了）マネージャを
    新しく生成します。
    
    パラメータ:
    
    systemMatterId - システム案件ID
  - ActvMatter
```
public ActvMatter(String localeId,
                  String systemMatterId)
```
    コンストラクタ。
    引数で指定したロケールID、システム案件IDで案件（未完了）マネージャを
    新しく生成します。
    
    パラメータ:
    
    localeId - ロケールID
    
    systemMatterId - システム案件ID
  - ActvMatter
```
@Deprecated
public ActvMatter(String loginGroupId,
                              String localeId,
                              String systemMatterId)
```
    非推奨です。 ActvMatter(String, String) を使用してください。
    
    コンストラクタ。
    引数で指定したログイングループID、ロケールID、システム案件IDで案件（未完了）マネージャを
    新しく生成します。
    
    パラメータ:
    
    loginGroupId - ログイングループID
    
    localeId - ロケールID
    
    systemMatterId - システム案件ID
- メソッドの詳細
  - getActvNodeList
```
public MatterActvNodeModel[] getActvNodeList()
                                      throws WorkflowException
```
    未完了案件の処理中のノード情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件に対して、現在処理中のノード情報を取得します。
    
    検索結果を保存する「処理中ノード情報の配列」にはデータベーステーブル「imw_t_actv_task」でシステム案件IDに該当する全てのノードが設定されています。
    データベーステーブル以外にノードの順・逆方向ノードIDを取得する為に、処理中の「flow.xml」情報も取得します。
    フローXML情報取得に関しては「getExecFlow()」を参照してください。
    処理中の「flow.xml」を参照せずに、データベーステーブルのみから情報を取得する場合は（順・逆方向ノードIDを取得しない場合）、「getActvNodeListWithoutRouteInfo()」を利用してください。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、最終処理IDで「flow.xml」情報取得に失敗した場合等、
    フローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    データベースへの検索処理が失敗した場合も「WorkflowException」が発生します。
    
    取得結果の「処理中ノード情報の配列」は明確なソート処理は行なっていません。
    
    戻り値:
    
    MatterActvNodeModel[] 案件ノード情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getActvNodeListWithoutRouteInfo
```
public MatterActvNodeModel[] getActvNodeListWithoutRouteInfo()
                                                      throws WorkflowException
```
    未完了案件の処理中のノード情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件に対して、現在処理中のノード情報を取得します。
    
    検索結果を保存する「処理中ノード情報の配列」にはデータベーステーブル「imw_t_actv_task」でシステム案件IDに該当する全てのノードが設定されています。
    返却モデルにあるノードの順・逆方向ノードIDは設定されません。
    ノードの順・逆方向ノードIDを含めて取得したい場合は、「getActvNodeList()」を利用してください。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
    データベースへの検索処理が失敗した場合は「WorkflowException」が発生します。
    
    取得結果の「処理中ノード情報の配列」は明確なソート処理は行なっていません。
    
    戻り値:
    
    MatterActvNodeModel[] 処理中ノード情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外
  - getAttachFile
```
public SessionScopeStorage getAttachFile(String systemFileName)
                                  throws WorkflowException
```
    指定した添付ファイルのセッションスコープストレージを取得します。
    
    セッションスコープストレージは、データベースに登録されている添付ファイルバイナリ情報からインスタンスを生成します。
    添付ファイルバイナリ情報が存在しない場合、nullが返却されます。
    
    パラメータ:
    
    systemFileName - システムファイル名
    
    戻り値:
    
    SessionScopeStorage 添付ファイルのセッションスコープストレージ
    
    例外:
    
    WorkflowException - セッションスコープストレージのインスタンスの生成に失敗した場合にスローされます。
    
    導入されたバージョン:
    
    8.0.14
  - getAttachFileList
```
public MatterAttachFileModel[] getAttachFileList()
                                          throws WorkflowException
```
    未完了案件の処理時に添付したファイルの情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の添付ファイル情報を取得します。
    
    検索結果を保存する「案件添付ファイル情報の配列」はデータベーステーブル
    「imw_t_actv_matter_attach_file」のデータが設定されています。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    添付ファイルは案件単位で管理されます。
    処理時に添付したファイルが複数存在する場合に取得結果のソート処理は行なっていません。
    
    完了案件の添付したファイルの情報を取得するには「CplMatter.getAttachFileList()」を利用してください。
    過去案件の添付したファイルの情報を取得するには「ArcMatter.getAttachFileList()」を利用してください。
    
    戻り値:
    
    MatterAttachFileModel[] 案件添付ファイル情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
    
    導入されたバージョン:
    
    7.2
  - getAttachFileListCount
```
public int getAttachFileListCount()
                           throws WorkflowException
```
    未完了案件の処理時に添付したファイルの情報の件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の添付ファイル情報件数を取得します。
    
    本メソッドの検索対象データベーステーブルは「imw_t_actv_matter_attach_file」です。
    
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    完了案件の添付したファイル件数を取得するには「CplMatter.getAttachFileListCount()」を利用してください。
    過去案件の添付したファイル件数を取得するには「ArcMatter.getAttachFileListCount()」を利用してください。
    
    戻り値:
    
    int 案件添付ファイル情報件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getCnfmAuthUserList
```
public CnfmAuthUserModel[] getCnfmAuthUserList(SortConditionForAuthUser<CnfmAuthUserType> cond)
                                        throws WorkflowException
```
    未完了案件の確認処理権限者情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で、その案件の確認ができる権限者情報をすべて取得します。
    検索条件を設定する為の引数である権限者情報ソート条件クラスの設定は必須です。
    特に検索条件を設定する必要がない場合でもインスタンスを作成して設定する必要があります。
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返します。
    
    検索結果を保存する「確認処理権限者情報の配列」はデータベーステーブル「imw_t_confirm_user」のデータが設定されています。
    
    CnfmAuthUserTypeに定義されているEnumをキーで検索条件を設定できます。
    詳しい使用方法は「SortConditionForAuthUser」を参照してください。
    
    パラメータで指定する権限者情報ソート条件クラスはソートの条件のみ指定できます。ノードを絞り込む為の条件としては使用できません。
    特定のノードに対して、そのノードの権限者情報取得するには、「ActvMatterNode.getCnfmAuthUserList(String, SortConditionForAuthUser)」を利用してください。
    完了した案件の確認処理権限者情報を取得するには「CplMatter.getCnfmAuthUserList(SortConditionForAuthUser)」を利用してください。
    
    パラメータ:
    
    cond - ソート条件
    
    戻り値:
    
    CnfmAuthUserModel[] 確認処理権限者情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getCnfmAuthUserListCount
```
public int getCnfmAuthUserListCount()
                             throws WorkflowException
```
    未完了案件の確認処理権限者情報の件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で、その案件の確認ができる権限者の全人数を取得します。
    本メソッドの検索対象データベーステーブルは「imw_t_confirm_user」です。
    
    特定のノードに対して、そのノードの権限者情報件数を取得するには、「ActvMatterNode.getCnfmAuthUserListCount(String)」を利用してください。
    完了した案件の確確認処理権限者情報の件数を取得するには「CplMatter.getCnfmAuthUserListCount()」を利用してください。
    
    戻り値:
    
    int 確認処理権限者情報件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getCnfmHistoryList
```
public MatterCnfmHistoryModel[] getCnfmHistoryList()
                                            throws WorkflowException
```
    未完了案件の確認履歴をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の確認履歴を取得します。
    
    検索結果を保存する「案件確認履歴情報の配列」はデータベーステーブル
    「imw_t_confirm」のデータが設定されています。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    確認ノードが複数ある場合は、全確認ノード分取得します。
    取得結果は「imw_t_confirm」テーブルの確認時間「confirm_date」順でソートされます。
    
    完了案件の確認履歴を取得するには「CplMatter.getCnfmHistoryList()」を利用してください。
    過去案件の確認履歴を取得するには「ArcMatter.getCnfmHistoryList()」を利用してください。
    
    戻り値:
    
    MatterCnfmHistoryModel[] 案件確認履歴の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getCnfmHistoryListCount
```
public int getCnfmHistoryListCount()
                            throws WorkflowException
```
    未完了案件の確認履歴の件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の確認履歴件数を取得します。
    
    本メソッドの検索対象データベーステーブルは「imw_t_confirm」です。
    確認ノードが複数ある場合は、全確認ノード分の件数を取得します。
    
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    完了案件の確認履歴件数を取得するには「CplMatter.getCnfmHistoryListCount()」を利用してください。
    過去案件の確認履歴件数を取得するには「ArcMatter.getCnfmHistoryListCount()」を利用してください。
    
    戻り値:
    
    int 案件確認履歴件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getExecFlow
```
public MatterFlowModel getExecFlow()
                            throws WorkflowException
```
    処理中の未完了案件の実行中フロー情報「flow.xml」を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    実行中の最新フロー情報「flow.xml」のXML内容を取得します。
    
    最新の「flow.xml」を取得するには、案件テーブル「imw_t_actv_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
    値を用いて、トランザクションファイルディレクトリから取得します。
    取得結果「案件フロー情報」には、「flow.xml」の内容が設定されます。
    
    案件フロー情報「MatterFlowModel」に設定される案件ノード情報「MatterNodeModel」は開始ノードから終了ノードまでの順でソートされます。
    分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、最終処理IDで「flow.xml」情報取得に失敗した場合等、
    フローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    本メソッドで取得する「MatterFlowModel 案件フロー情報」にはそのノードで実行可能な処理種別情報は含まれていませんが、
    ノードが展開されたノードの場合（横・縦配置ノードの子ノード）にその親ノードのタイプやIDは取得できます。
    （１つのノードに対して同様の情報は「ActvMatterNode.getMatterNode(String)」から取得できます。）
    そのノードで実行可能な処理種別情報が必要な場合には、「getExecNodeListWithProcessType()」を利用してください。
    
    フローXMLを「案件フロー情報」モデルではなく、XML文字列で取得するには「getExecFlowXML()」を利用してください。
    
    完了案件のフロー情報を取得するには「CplMatter.getExecFlow()」を利用してください。
    過去案件のフロー情報を取得するには「ArcMatter.getExecFlow()」を利用してください。
    
    戻り値:
    
    MatterFlowModel 案件フロー情報
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getExecFlowXML
```
public String getExecFlowXML()
                      throws WorkflowException
```
    処理中の未完了案件の実行中フロー情報「flow.xml」を文字列で取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    実行中の最新フロー情報「flow.xml」のXML内容を文字列で取得します。
    
    最新の「flow.xml」を取得するには、案件テーブル「imw_t_actv_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
    値を用いて、トランザクションファイルディレクトリから取得します。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、最終処理IDで「flow.xml」情報取得に失敗した場合等、
    フローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    フローXMLを内容を文字列ではなく、オブジェクトで取得するには「getExecFlow()」を利用してください。
    
    完了案件のフロー情報を文字列で取得するには「CplMatter.getExecFlowXML()」を利用してください。
    過去案件のフロー情報を文字列で取得するには「ArcMatter.getExecFlowXML()」を利用してください。
    
    戻り値:
    
    String XML文字列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getExecNodeListWithProcessType
```
public MatterNodeWithProcessTypeModel[] getExecNodeListWithProcessType()
                                                                throws WorkflowException
```
    処理中の未完了案件の実行中フロー情報「flow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    実行中の最新フロー情報「flow.xml」のXML内容を取得し、ノード情報を取得します。
    
    最新の「flow.xml」を取得するには、案件テーブル「imw_t_actv_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
    値を用いて、トランザクションファイルディレクトリから取得します。
    取得結果「案件フロー情報」には、「flow.xml」の内容が設定されます。
    取得結果である「MatterNodeWithProcessTypeModel[] 案件ノード情報」は開始ノードから終了ノードまでの順でソートされます。
    分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、最終処理IDで「flow.xml」情報取得に失敗した場合等、
    フローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    ノード情報ではなく、フロー情報を取得するには「getExecFlow()」を利用してください。
    「getExecFlow()」で取得できるノード情報にはノードで実行可能な処理種別情報は含まれていませんが、
    ノードが展開されたノードの場合（横・縦配置ノードの子ノード）にその親ノードのタイプやIDは取得できます。
    １つのノードに対して同様の情報は「ActvMatterNode.getExecNodeConfig(String)」から取得できます。
    「ActvMatterNode.getExecNodeConfig(String)」で取得できる情報には、処理種別以外の全てのノード設定情報が含まれています。
    
    処理中の最新フロー情報ではなく、申請・起票時のマスタフローからノード情報を取得するには「getMasterNodeListWithProcessType()」を利用してください。
    
    完了案件のノード情報を取得するには「CplMatter.getExecNodeListWithProcessType()」を利用してください。
    過去案件のノード情報を取得するには「ArcMatter.getExecNodeListWithProcessType()」を利用してください。
    
    戻り値:
    
    MatterNodeWithProcessTypeModel[] 案件ノード情報（ノード別処理種別含む）の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMasterFlow
```
public MatterFlowModel getMasterFlow()
                              throws WorkflowException
```
    処理中の未完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」情報を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    マスタフロー情報「masterflow.xml」のXML内容を取得します。
    
    取得結果「案件フロー情報」には、「masterflow.xml」の内容が設定されます。
    
    案件フロー情報「MatterFlowModel」に設定される案件ノード情報「MatterNodeModel」は開始ノードから終了ノードまでの順でソートされます。
    分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    本メソッドで取得する「MatterFlowModel 案件フロー情報」にはそのノードで実行可能な処理種別情報は含まれていませんが、
    ノードが展開されたノードの場合（横・縦配置ノードの子ノード）にその親ノードのタイプやIDは取得できます。
    そのノードで実行可能な処理種別情報が必要な場合には、「getMasterNodeListWithProcessType()」を利用してください。
    
    フローXMLを「案件フロー情報」モデルではなく、XML文字列で取得するには「getMasterFlowXML()」を利用してください。
    
    完了案件のマスタフロー情報を取得するには「CplMatter.getMasterFlow()」を利用してください。
    過去案件のマスタフロー情報を取得するには「ArcMatter.getMasterFlow()」を利用してください。
    
    戻り値:
    
    MatterFlowModel 案件フロー情報
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMasterFlowXML
```
public String getMasterFlowXML()
                        throws WorkflowException
```
    処理中の未完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」を文字列で取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    マスタフロー情報「masterflow.xml」のXML内容を文字列で取得します。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    フローXMLを内容を文字列ではなく、オブジェクトで取得するには「getMasterFlow()」を利用してください。
    
    完了案件のマスタフロー情報を取得するには「CplMatter.getMasterFlowXML()」を利用してください。
    過去案件のマスタフロー情報を取得するには「ArcMatter.getMasterFlowXML()」を利用してください。
    
    戻り値:
    
    String XML文字列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMasterNodeListWithProcessType
```
public MatterNodeWithProcessTypeModel[] getMasterNodeListWithProcessType()
                                                                  throws WorkflowException
```
    処理中の未完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
    マスタフロー情報「masterflow.xml」のXML内容を取得し、ノード情報を取得します。
    
    取得結果である「MatterNodeWithProcessTypeModel[] 案件ノード情報」は開始ノードから終了ノードまでの順でソートされます。
    分岐ノードで複数のノードに繋がる場合は、ルートを繋いた順でソートされます。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、マスタフローXML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    ノード情報ではなく、マスタフロー情報を取得するには「getMasterFlow()」を利用してください。
    「getMasterFlow()」で取得できるノード情報にはノードで実行可能な処理種別情報は含まれていませんが、
    ノードが展開されたノードの場合（横・縦配置ノードの子ノード）にその親ノードのタイプやIDは取得できます。
    １つのノードに対して同様の情報は「ActvMatterNode.getMasterNodeConfig(String)」から取得できます。
    「ActvMatterNode.getMasterNodeConfig(String)」で取得できる情報には、処理種別以外の全てのノード設定情報が含まれています。
    
    マスタフローではなく、実行中の最新フローからノード情報を取得するには「getExecNodeListWithProcessType()」を利用してください。
    
    完了案件のノード情報を取得するには「CplMatter.getMasterNodeListWithProcessType()」を利用してください。
    過去案件のノード情報を取得するには「ArcMatter.getMasterNodeListWithProcessType()」を利用してください。
    
    戻り値:
    
    MatterNodeWithProcessTypeModel[] 案件ノード情報（ノード別処理種別含む）の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatter
```
public ActvMatterModel getMatter()
                          throws WorkflowException
```
    未完了案件情報を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」で案件情報を取得します。
    検索結果を保存する「未完了案件情報」にはデータベーステーブル
    「imw_t_actv_matter」と「imw_t_actv_matter_locale」のデータが設定されます。
    モデル内の「ユーザデータ案件プロパティ」には「imw_t_user_data」のデータが設定されます。
    
    １つのシステムで１つのロケールに対して同じシステム案件IDが２個以上存在するのは不可能です。
    検索の結果、２個以上のデータが取得された場合には、エラーと判断し、「null」を返却します。
    検索した結果がない場合でも「null」を返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    完了した案件情報を取得するには「CplMatter.getMatter()」を利用してください。
    過去案件情報を取得するには「ArcMatter.getMatter()」を利用してください。
    
    戻り値:
    
    ActvMatterModel 未完了案件情報
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterHandleAuth
```
public MatterHandleAuthUserModel getMatterHandleAuth(String matterHandleUserCd)
                                              throws WorkflowException
```
    未完了案件の案件操作権限情報を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で、
    その案件の操作ができる権限者情報の中、パラメータで指定した人の情報のみを取得します。
    
    指定したパラメータのユーザに対して、検索の結果、情報が取得出来なかった場合、もしくは２個以上のデータが取得された場合には、
    エラーと判断し、「null」を返却します。
    
    検索結果を保存する「案件操作権限者情報」はデータベーステーブル「imw_t_actv_matter_handle_user」のデータが設定されています。
    
    特定のユーザに限らず、全ユーザのデータを取得するには「getMatterHandleAuthList(SortConditionForAuthUser)」を利用してください。
    
    完了した案件の案件操作権限情報を取得するには「CplMatter.getMatterHandleAuthUser(String)」を利用してください。
    
    パラメータ:
    
    matterHandleUserCd - 案件操作権限者コード
    
    戻り値:
    
    MatterHandleAuthUserModel 案件操作権限者情報
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterHandleAuthList
```
public MatterHandleAuthUserModel[] getMatterHandleAuthList(SortConditionForAuthUser<MatterHandleAuthUserType> cond)
                                                    throws WorkflowException
```
    未完了案件の案件操作権限情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で、その案件の操作ができる権限者情報をすべて取得します。
    
    検索条件を設定する為の引数である権限者情報ソート条件クラスの設定は必須です。
    特に検索条件を設定する必要がない場合でもインスタンスを作成して設定する必要があります。
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返します。
    
    検索結果を保存する「案件操作権限者情報の配列」はデータベーステーブル「imw_t_actv_matter_handle_user」のデータが設定されています。
    
    MatterHandleAuthUserTypeに定義されているEnumをキーで検索条件を設定できます。
    詳しい使用方法は「SortConditionForAuthUser」を参照してください。
    
    パラメータで指定する権限者情報ソート条件クラスはソートの条件のみ指定できます。ユーザを絞り込む為の条件としては使用できません。
    特定のユーザに対して、その１人の権限者情報取得するには、「getMatterHandleAuth(String)」を利用してください。
    完了した案件の案件操作権限情報を取得するには「CplMatter.getMatterHandleAuthUserList(SortConditionForAuthUser)」を利用してください。
    
    パラメータ:
    
    cond - ソート条件
    
    戻り値:
    
    MatterHandleAuthUserModel[] 案件操作権限者情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterHandleAuthListCount
```
public int getMatterHandleAuthListCount()
                                 throws WorkflowException
```
    未完了案件の案件操作権限情報の件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で、その案件の操作ができる権限者の全人数を取得します。
    本メソッドの検索対象データベーステーブルは「imw_t_actv_matter_handle_user」です。
    
    完了した案件の案件操作権限情報の件数を取得するには「CplMatter.getMatterHandleAuthUserListCount()」を利用してください。
    
    戻り値:
    
    int 案件操作権限情報件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterProperty
```
public UserMatterPropertyModel getMatterProperty(String key)
                                          throws WorkflowException
```
    未完了案件の特定のユーザデータ案件プロパティ情報を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件に登録されているユーザデータIDと、
    パラメータに指定した「key 案件プロパティキー」でユーザデータ情報を取得します。
    
    検索結果を保存する「ユーザデータ案件プロパティ情報の配列」はデータベーステーブル
    「imw_t_user_data」のデータが設定されています。
    ユーザデータテーブル「imw_t_user_data」の検索用ユーザデータIDは案件情報テーブル
    「imw_t_actv_matter」の「USER_DATA_ID」カラムから取得します。
    
    同じユーザデータIDに重複するキーは存在できません。検索の結果、情報が取得出来なかった場合、
    もしくは２個以上のデータが取得された場合には、エラーと見なして、「null」を返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    特定の案件プロパティキーに限らず、案件に紐づいている全てのユーザデータを取得するには「getMatterPropertyList()}」を利用してください。
    完了案件の特定のユーザデータ案件プロパティ情報を取得するには「CplMatter.getMatterProperty(String)」を利用してください。
    過去案件の特定のユーザデータ案件プロパティ情報を取得するには「ArcMatter.getMatterProperty(String)」を利用してください。
    
    システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報を取得するには
    「 UserActvMatterPropertyValue.getMatterProperty(String, String)」を利用してください。
    
    パラメータ:
    
    key - 案件プロパティキー
    
    戻り値:
    
    UserMatterPropertyModel ユーザデータ案件プロパティ情報
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterPropertyList
```
public UserMatterPropertyModel[] getMatterPropertyList()
                                                throws WorkflowException
```
    未完了案件のユーザデータ案件プロパティ情報をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件に登録されているユーザデータIDで、
    案件に紐づいているユーザデータ情報を全て取得します。
    
    検索結果を保存する「ユーザデータ案件プロパティ情報の配列」はデータベーステーブル
    「imw_t_user_data」のデータが設定されています。
    ユーザデータテーブル「imw_t_user_data」の検索用ユーザデータIDは案件情報テーブル
    「imw_t_actv_matter」の「USER_DATA_ID」カラムから取得します。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    全てのユーザデータではなく、特定の案件プロパティを取得するには「getMatterProperty(String)}」を利用してください。
    
    完了案件のユーザデータ案件プロパティ情報を全て取得するには「CplMatter.getMatterPropertyList()」を利用してください。
    過去案件のユーザデータ案件プロパティ情報を全て取得するには「ArcMatter.getMatterPropertyList()」を利用してください。
    
    システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報を取得するには
    「 UserActvMatterPropertyValue.getMatterPropertyList(String)」を利用してください。
    
    戻り値:
    
    UserMatterPropertyModel[] ユーザデータ案件プロパティ情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getMatterPropertyListCount
```
public int getMatterPropertyListCount()
                               throws WorkflowException
```
    未完了案件のユーザデータ案件プロパティ情報の件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件に登録されているユーザデータIDで、
    案件に紐づいているユーザデータ情報の件数を取得します。
    
    本メソッドの検索対象データベーステーブルは「imw_t_user_data」です。
    ユーザデータテーブル「imw_t_user_data」の検索用ユーザデータIDは案件情報テーブル
    「imw_t_actv_matter」の「USER_DATA_ID」カラムから取得します。
    
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    完了案件のユーザデータ案件プロパティ情報の件数を取得するには「CplMatter.getMatterPropertyListCount()」を利用してください。
    過去案件のユーザデータ案件プロパティ情報の件数を取得するには「ArcMatter.getMatterPropertyListCount()」を利用してください。
    
    システム案件IDではなく、ユーザデータIDをキーにユーザデータ案件プロパティ情報件数を取得するには
    「 UserActvMatterPropertyValue.getMatterPropertyListCount(String)」を利用してください。
    
    戻り値:
    
    int ユーザデータ案件プロパティ情報件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getNodeProgressList
```
public NodeProgressModel[] getNodeProgressList()
                                        throws WorkflowException
```
    処理中の未完了案件の進捗ファイル情報「progress.xml」を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の実行中の最新進捗情報「progress.xml」のXML内容を取得します。
    
    最新の「progress.xml」を取得するには、案件テーブル「imw_t_actv_matter」の最終処理ID「LAST_PROCESS_ID」に保存されている
    値を用いて、トランザクションファイルディレクトリから取得します。
    取得結果「ノード進捗情報」には、「progress.xml」の内容が設定されます。
    
    取得結果である「NodeProgressModel[] ノード進捗情報の配列」のソート順は進捗情報ファイル「progress.xml」の解析順になります。明確なソート処理は行なっていません。
    
    コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、最終処理IDで「progress.xml」情報取得に失敗した場合等、
    進捗XML情報が取得できなかった場合は「WorkflowException」が発生します。
    
    完了案件の進捗ファイル情報を取得するには「CplMatter.getNodeProgressList()」を利用してください。
    過去案件の進捗ファイル情報を取得するには「ArcMatter.getNodeProgressList()」を利用してください。
    
    戻り値:
    
    NodeProgressModel[] ノード進捗情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getProcessHistoryLatestList
```
public MatterProcessHistoryModel[] getProcessHistoryLatestList()
                                                        throws WorkflowException
```
    処理中の未完了案件の処理履歴の最新情報を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件のノードの最新履歴を取得します。
    履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
```
 【ノード種別】
 　・申請ノード
 　・承認ノード
 　・動的承認ノード
 　・システムノード
 
```
    検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル
    「imw_t_cpl_task」、「imw_t_cpl_user」のデータが設定されています。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    本メソッドは差戻しや引戻し等によって、１つのノードが複数回処理された場合には、
    対象ノードに対して最後に処理された最新データのみを取得します。最新データかどうかは、「imw_t_cpl_task」テーブルの「end_date」によって判断します。
    
    各ノードに対して、最新履歴（最後に処理された履歴）のみではなく、全ての履歴を取得する場合には「getProcessHistoryList()」を利用してください。
    
    全ノードデータではなく、１つの特定ノードに対して最新履歴を取得する場合には、「ActvMatterNode.getProcessHistoryLatest(String)」を利用してください。
    
    完了案件の処理履歴を取得するには「CplMatter.getProcessHistoryLatestList()」を利用してください。
    過去案件の処理履歴を取得するには「ArcMatter.getProcessHistoryLatestList()」を利用してください。
    
    ※このメソッドで取得する履歴にはキャンセルステータスや復元ステータス等も全て含めています。
    ※標準フロー詳細画面で使用しているタグリブ「workflow:workflowMatterResult」の出力結果とは異なります。
    戻り値:
    
    MatterProcessHistoryModel[] 案件処理履歴情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
    
    導入されたバージョン:
    
    7.2
  - getProcessHistoryList
```
public MatterProcessHistoryModel[] getProcessHistoryList()
                                                  throws WorkflowException
```
    処理中の未完了案件の処理履歴をすべて取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件のノード処理履歴をすべて取得します。
    履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
```
 【ノード種別】
 　・申請ノード
 　・承認ノード
 　・動的承認ノード
 　・システムノード
 
```
    検索結果を保存する「案件処理履歴情報の配列」はデータベーステーブル
    「imw_t_cpl_task」、「imw_t_cpl_user」のデータが設定されています。
    
    取得した結果が複数存在する場合は、処理時間順に返却します。
    処理時間順のソートは「imw_t_cpl_task」テーブルの「end_date」カラムで行なっています。
    
    検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    本メソッドは差戻しや引戻し等によって、１つのノードが複数回処理された場合には、１つのノードに対して複数履歴が取得されます。
    各ノードに対して、最新履歴（最後に処理された履歴）のみ取得する場合には「getProcessHistoryLatestList()」を利用してください。
    
    全ノードデータではなく、１つの特定ノードに対して履歴を取得する場合には、「ActvMatterNode.getProcessHistoryList(String)」を利用してください。
    
    完了案件の処理履歴を取得するには「CplMatter.getProcessHistoryList()」を利用してください。
    過去案件の処理履歴を取得するには「ArcMatter.getProcessHistoryList()」を利用してください。
    
    ※このメソッドで取得する履歴にはキャンセルステータスや復元ステータス等も全て含めています。
    ※標準履歴詳細画面で使用しているタグリブ「workflow:workflowMatterHistory」の出力結果とは異なります。
    戻り値:
    
    MatterProcessHistoryModel[] 案件処理履歴情報の配列
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getProcessHistoryListCount
```
public int getProcessHistoryListCount()
                               throws WorkflowException
```
    処理中の未完了案件の処理履歴件数を取得します。
    
    コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件のノード処理履歴の全件数を取得します。
    履歴を取得する対象ノードは、ユーザが処理する下記のノード種別を持つノードです。
```
 【ノード種別】
 　・申請ノード
 　・承認ノード
 　・動的承認ノード
 　・システムノード
 
```
    本メソッドの検索対象データベーステーブルは「imw_t_cpl_task」、「imw_t_cpl_user」です。
    差戻しや引戻し等によって、１つのノードが複数回処理された場合には、１つのノードに対して複数履歴件数が取得されます。
    
    データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。
    
    全ノードデータではなく、１つの特定ノードに対して履歴件数を取得する場合には、「ActvMatterNode.getProcessHistoryListCount(String)」を利用してください。
    
    完了案件の処理履歴を取得するには「CplMatter.getProcessHistoryListCount()」を利用してください。
    過去案件の処理履歴を取得するには「ArcMatter.getProcessHistoryListCount()」を利用してください。
    戻り値:
    
    int 案件処理履歴情報件数
    
    例外:
    
    WorkflowException - ワークフロー例外の親クラス
  - getPropertyTable
```
protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql getPropertyTable()
                                                                                                   throws jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOException
```
    案件プロパティ（ユーザデータ）テーブルを取得します。
    
    定義:
    
    getPropertyTable クラス内 jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
    
    戻り値:
    
    SubSearchSql 案件プロパティ（ユーザデータ）テーブル
    
    例外:
    
    jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOException - DAO例外クラス
  - getSearchMainTable
```
protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql getSearchMainTable()
                                                                                                     throws jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOException
```
    検索メイン用テーブルを取得します。
    
    定義:
    
    getSearchMainTable クラス内 jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
    
    戻り値:
    
    SubSearchSql テーブル
    
    例外:
    
    jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOException - DAO例外クラス

クラス ActvMatter

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

フィールドのサマリー

クラスから継承されたフィールド jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

クラスから継承されたフィールド jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

クラスから継承されたメソッド jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ActvMatter

ActvMatter

ActvMatter

メソッドの詳細

getActvNodeList

getActvNodeListWithoutRouteInfo

getAttachFile

getAttachFileList

getAttachFileListCount

getCnfmAuthUserList

getCnfmAuthUserListCount

getCnfmHistoryList

getCnfmHistoryListCount

getExecFlow

getExecFlowXML

getExecNodeListWithProcessType

getMasterFlow

getMasterFlowXML

getMasterNodeListWithProcessType

getMatter

getMatterHandleAuth

getMatterHandleAuthList

getMatterHandleAuthListCount

getMatterProperty

getMatterPropertyList

getMatterPropertyListCount

getNodeProgressList

getProcessHistoryLatestList

getProcessHistoryList

getProcessHistoryListCount

getPropertyTable

getSearchMainTable