CplMatter オブジェクト

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

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

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

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

オブジェクトに定義されている定数値は検索、ソート条件で利用されますが、 返却オブジェクトに指定されていないフィールドでのソートはできません。

関連オブジェクト:ActvMatter, ArcMatter, CplMatterNode, TempSaveMatter
導入されたバージョン:7.2

定数の概要
static String CHANGE_USER_FLAG
処理対象者変更フラグ
案件操作権限情報
static String CONFIRM_CPL_FLAG
確認済みフラグ
完了案件の確認処理権限者情報
static String DELETE_DYNAMIC_NODE_FLAG
動的処理ノード削除フラグ
案件操作権限情報
static String EXPAND_USER_FLAG
処理対象者展開フラグ
案件操作権限情報
static String HANDLE_LEVEL
操作レベル
案件操作権限情報
static String HANDLE_MOVE_BACKWARD_FLAG
案件操作後進フラグ
案件操作権限情報
static String HANDLE_MOVE_FORWARD_FLAG
案件操作前進フラグ
案件操作権限情報
static String HANDLE_TERMINATE_FLAG
案件操作終了フラグ
案件操作権限情報
static String HORIZONTAL_NODE_CONFIG_FLAG
横配置ノード設定フラグ
案件操作権限情報
static String RESERVE_CANCEL_FLAG
保留解除フラグ
案件操作権限情報
static String UNDELETE_DYNAMIC_NODE_FLAG
動的処理ノード復活フラグ
案件操作権限情報
static String USER_CODE
ユーザコード
案件操作権限情報・確認処理権限者情報共通
static String USER_NAME
ユーザ名
案件操作権限情報・確認処理権限者情報共通
static String VERTICAL_NODE_CONFIG_FLAG
縦配置ノード設定フラグ
案件操作権限情報

コンストラクタの概要
CplMatter (String loginGroupId ,String localeId ,String systemMatterId)
コンストラクタ。

メソッドの概要
WorkflowResultInfo getAttachFileList ()
完了案件の処理時に添付したファイルの情報をすべて取得します。
WorkflowResultInfo getAttachFileListCount ()
完了案件の処理時に添付したファイルの情報の件数を取得します。
WorkflowResultInfo getCnfmAuthUserList (SortConditionForAuthUser cond)
完了案件の確認処理権限者情報をすべて取得します。
WorkflowResultInfo getCnfmAuthUserListCount ()
完了案件の確認処理権限者情報の件数を取得します。
WorkflowResultInfo getCnfmHistoryList ()
完了案件の確認履歴をすべて取得します。
WorkflowResultInfo getCnfmHistoryListCount ()
完了案件の確認履歴の件数を取得します。
WorkflowResultInfo getExecFlow ()
完了案件の最終処理結果フロー情報「flow.xml」を取得します。
WorkflowResultInfo getExecFlowXML ()
完了案件の最終処理結果フロー情報「flow.xml」を文字列で取得します。
WorkflowResultInfo getExecNodeListWithProcessType ()
完了案件の最終処理結果フロー情報「flow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
WorkflowResultInfo getMasterFlow ()
完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」情報を取得します。
WorkflowResultInfo getMasterFlowXML ()
完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」を文字列で取得します。
WorkflowResultInfo getMasterNodeListWithProcessType ()
完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。
WorkflowResultInfo getMatter ()
完了案件情報を取得します。
WorkflowResultInfo getMatterHandleAuthUser (String matterHandleUserCd)
完了案件の案件操作権限者情報を取得します。
WorkflowResultInfo getMatterHandleAuthUserList (SortConditionForAuthUser cond)
完了案件の案件操作権限者情報をすべて取得します。
WorkflowResultInfo getMatterHandleAuthUserListCount ()
完了案件の案件操作権限者情報の件数を取得します。
WorkflowResultInfo getMatterProperty (String key)
完了案件の特定のユーザデータ案件プロパティ情報を取得します。
WorkflowResultInfo getMatterPropertyList ()
完了案件のユーザデータ案件プロパティ情報をすべて取得します。
WorkflowResultInfo getMatterPropertyListCount ()
完了案件のユーザデータ案件プロパティ情報の件数を取得します。
WorkflowResultInfo getNodeProgressList ()
完了案件の進捗ファイル情報「progress.xml」を取得します。
WorkflowResultInfo getProcessHistoryLatestList ()
完了案件の処理履歴の最新情報を取得します。
WorkflowResultInfo getProcessHistoryList ()
完了案件の処理履歴をすべて取得します。
WorkflowResultInfo getProcessHistoryListCount ()
完了案件の処理履歴件数を取得します。

定数の詳細
CHANGE_USER_FLAG

static String CHANGE_USER_FLAG

処理対象者変更フラグ
案件操作権限情報

CONFIRM_CPL_FLAG

static String CONFIRM_CPL_FLAG

確認済みフラグ
完了案件の確認処理権限者情報

DELETE_DYNAMIC_NODE_FLAG

static String DELETE_DYNAMIC_NODE_FLAG

動的処理ノード削除フラグ
案件操作権限情報

EXPAND_USER_FLAG

static String EXPAND_USER_FLAG

処理対象者展開フラグ
案件操作権限情報

HANDLE_LEVEL

static String HANDLE_LEVEL

操作レベル
案件操作権限情報

HANDLE_MOVE_BACKWARD_FLAG

static String HANDLE_MOVE_BACKWARD_FLAG

案件操作後進フラグ
案件操作権限情報

HANDLE_MOVE_FORWARD_FLAG

static String HANDLE_MOVE_FORWARD_FLAG

案件操作前進フラグ
案件操作権限情報

HANDLE_TERMINATE_FLAG

static String HANDLE_TERMINATE_FLAG

案件操作終了フラグ
案件操作権限情報

HORIZONTAL_NODE_CONFIG_FLAG

static String HORIZONTAL_NODE_CONFIG_FLAG

横配置ノード設定フラグ
案件操作権限情報

RESERVE_CANCEL_FLAG

static String RESERVE_CANCEL_FLAG

保留解除フラグ
案件操作権限情報

UNDELETE_DYNAMIC_NODE_FLAG

static String UNDELETE_DYNAMIC_NODE_FLAG

動的処理ノード復活フラグ
案件操作権限情報

USER_CODE

static String USER_CODE

ユーザコード
案件操作権限情報・確認処理権限者情報共通

USER_NAME

static String USER_NAME

ユーザ名
案件操作権限情報・確認処理権限者情報共通

VERTICAL_NODE_CONFIG_FLAG

static String VERTICAL_NODE_CONFIG_FLAG

縦配置ノード設定フラグ
案件操作権限情報

コンストラクタの詳細
CplMatter

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

メソッドの詳細
getAttachFileList

WorkflowResultInfo getAttachFileList ()

完了案件の処理時に添付したファイルの情報をすべて取得します。

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

検索結果を保存する「案件添付ファイル情報オブジェクトの配列」はデータベーステーブル
「imw_t_cpl_matter_attach_file」のデータが設定されています。

検索結果が存在しない場合にはdata属性にサイズ0の空オブジェクトを設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件添付ファイル情報オブジェクトの配列が設定されます。

getAttachFileListCount

WorkflowResultInfo getAttachFileListCount ()

完了案件の処理時に添付したファイルの情報の件数を取得します。

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

本メソッドの検索対象データベーステーブルは「imw_t_cpl_matter_attach_file」です。

データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件添付ファイル情報件数(Number)が設定されます。

getCnfmAuthUserList

WorkflowResultInfo getCnfmAuthUserList (SortConditionForAuthUser cond)

完了案件の確認処理権限者情報をすべて取得します。

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

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

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

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

特定のノードに対して、そのノードの権限者情報取得するには、「CplMatterNode#getCnfmAuthUserList(String, SortConditionForAuthUser)」を利用してください。

処理中の未完了案件の確認処理権限者情報を取得するには「ActvMatter#getCnfmAuthUserList(SortConditionForAuthUser)」を利用してください。

パラメータ
cond SortConditionForAuthUser ソート条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、確認処理権限者情報オブジェクトの配列が設定されます。

getCnfmAuthUserListCount

WorkflowResultInfo getCnfmAuthUserListCount ()

完了案件の確認処理権限者情報の件数を取得します。

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

特定のノードに対して、そのノードの権限者情報件数を取得するには、「CplMatterNode#getCnfmAuthUserListCount(String)」を利用してください。

処理中の未完了案件の確確認処理権限者情報の件数を取得するには「ActvMatter#getCnfmAuthUserListCount()」を利用してください。

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、確認処理権限者情報件数(Number)が設定されます。

getCnfmHistoryList

WorkflowResultInfo getCnfmHistoryList ()

完了案件の確認履歴をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の確認履歴を取得します。

検索結果を保存する「案件確認履歴情報オブジェクトの配列」はデータベーステーブル
「imw_t_cpl_matter_confirm」のデータが設定されています。

検索結果が存在しない場合にはdata属性にサイズ0の空オブジェクトを設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件確認履歴情報オブジェクトの配列が設定されます。

getCnfmHistoryListCount

WorkflowResultInfo getCnfmHistoryListCount ()

完了案件の確認履歴の件数を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」で取得した案件の確認履歴件数を取得します。

本メソッドの検索対象データベーステーブルは「imw_t_cpl_matter_confirm」です。
確認ノードが複数ある場合は、全確認ノード分の件数を取得します。

データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件確認履歴情報件数(Number)が設定されます。

getExecFlow

WorkflowResultInfo getExecFlow ()

完了案件の最終処理結果フロー情報「flow.xml」を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
最終処理結果フロー情報「flow.xml」の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

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

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合には処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件フロー情報オブジェクトが設定されます。

getExecFlowXML

WorkflowResultInfo getExecFlowXML ()

完了案件の最終処理結果フロー情報「flow.xml」を文字列で取得します。

コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
最終処理結果フロー情報「flow.xml」の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で「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合は、処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、XML文字列(String)が設定されます。

getExecNodeListWithProcessType

WorkflowResultInfo getExecNodeListWithProcessType ()

完了案件の最終処理結果フロー情報「flow.xml」から定義されているノードを、実施可能な処理種別情報とともにすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」の該当案件の
最終処理結果フロー情報「flow.xml」の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

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

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「flow.xml」情報取得に失敗した場合等、フローXML情報が取得できなかった場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件ノード情報(ノード別処理種別含む)オブジェクトの配列が設定されます。

getMasterFlow

WorkflowResultInfo getMasterFlow ()

完了案件の申請・起票時の初期フロー設定情報であるマスタフロー「masterflow.xml」情報を取得します。

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

取得結果「案件フロー情報オブジェクト」には、標準の設定の場合は、下記の「masterflow.xml」の内容が設定されます。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml
※未完了案件用のマスタフロー取得メソッドと完了案件用のマスタフロー取得メソッドは同じファイルを参照します。

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

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件フロー情報オブジェクトが設定されます。

getMasterFlowXML

WorkflowResultInfo getMasterFlowXML ()

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

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

標準設定の場合、取得対象の「masterflow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml
※未完了案件用のマスタフローXML取得メソッドと完了案件用のマスタフローXML取得メソッドは同じファイルを参照します。

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、XML文字列(String)が設定されます。

getMasterNodeListWithProcessType

WorkflowResultInfo getMasterNodeListWithProcessType ()

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

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

標準設定の場合、取得対象の「masterflow.xml」は下記に格納されています。
※{%StorageService%}/storage/workflow/data/{%ログイングループID%}/transaction/yyyymm/dd/hh/{%システム案件ID%}/masterflow.xml
※未完了案件用のマスタフローXML取得メソッドと完了案件用のマスタフローXML取得メソッドは同じファイルを参照します。

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

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合等、
マスタフローXML情報が取得できなかった場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件ノード情報(ノード別処理種別含む)オブジェクトの配列が設定されます。

getMatter

WorkflowResultInfo getMatter ()

完了案件情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」と「localeId ロケールID」で案件情報を取得します。
検索結果を保存する「完了案件情報オブジェクト」にはデータベーステーブル
「imw_t_cpl_matter」と「imw_t_cpl_matter_locale」のデータが設定されます。
モデル内の「ユーザデータ案件プロパティ」には「imw_t_cpl_maatter_user_data」のデータが設定されます。

1つのシステムで1つのロケールに対して同じシステム案件IDが2個以上存在するのは不可能です。
検索の結果、2個以上のデータが取得された場合には、エラーと判断して、data属性に「null」を設定して返却します。
検索した結果がない場合でもdata属性に「null」を設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、完了案件情報オブジェクトが設定されます。

getMatterHandleAuthUser

WorkflowResultInfo getMatterHandleAuthUser (String matterHandleUserCd)

完了案件の案件操作権限者情報を取得します。

コンストラクタに指定した「systemMatterId システム案件ID」で、
その案件の操作ができる権限者情報の中、パラメータで指定した人の情報のみを取得します。

指定したパラメータのユーザに対して、検索の結果、情報が取得出来なかった場合、もしくは2個以上のデータが取得された場合には、
エラーと判断して、data属性に「null」を設定して返却します。

検索結果を保存する「案件操作権限者情報オブジェクト」はデータベーステーブル「imw_t_cpl_matter_handle_user」のデータが設定されています。

特定のユーザに限らず、全ユーザのデータを取得するには「getMatterHandleAuthUserList(SortConditionForAuthUser)」を利用してください。

処理中の未完了案件の案件操作権限情報を取得するには「ActvMatter#getMatterHandleAuth(String)」を利用してください。

パラメータ
matterHandleUserCd String 案件操作権限者コード
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件操作権限者情報オブジェクトが設定されます。

getMatterHandleAuthUserList

WorkflowResultInfo getMatterHandleAuthUserList (SortConditionForAuthUser cond)

完了案件の案件操作権限者情報をすべて取得します。

コンストラクタに指定した「systemMatterId システム案件ID」で、
その案件の操作ができる権限者情報をすべて取得します。

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

検索結果を保存する「案件操作権限者情報オブジェクトの配列」はデータベーステーブル
「imw_t_cpl_matter_handle_user」のデータが設定されています。

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

特定のユーザに対して、その1人の権限者情報取得するには、「getMatterHandleAuthUser(String)」を利用してください。

処理中の未完了案件の案件操作権限情報を取得するには「ActvMatter#getMatterHandleAuthList(SortConditionForAuthUser)」を利用してください。

パラメータ
cond SortConditionForAuthUser ソート条件オブジェクト
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件操作権限情報オブジェクトの配列が設定されます。

getMatterHandleAuthUserListCount

WorkflowResultInfo getMatterHandleAuthUserListCount ()

完了案件の案件操作権限者情報の件数を取得します。

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

処理中の未完了案件の案件操作権限者情報の件数を取得するには「 ActvMatter#getMatterHandleAuthListCount()」を利用してください。

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件操作権限情報件数(Number)が設定されます。

getMatterProperty

WorkflowResultInfo getMatterProperty (String key)

完了案件の特定のユーザデータ案件プロパティ情報を取得します。

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

検索結果を保存する「ユーザデータ案件プロパティ情報オブジェクトの配列」はデータベーステーブル
「imw_t_cpl_matter_user_data」のデータが設定されています。
ユーザデータテーブル「imw_t_cpl_matter_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_t_cpl_matter」の「USER_DATA_ID」カラムから取得します。

同じユーザデータIDに重複するキーは存在できません。検索の結果、情報が取得出来なかった場合、
もしくは2個以上のデータが取得された場合には、エラーと判断して、data属性に「null」を設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

パラメータ
key String 案件プロパティキー
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報オブジェクトが設定されます。

getMatterPropertyList

WorkflowResultInfo getMatterPropertyList ()

完了案件のユーザデータ案件プロパティ情報をすべて取得します。

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

検索結果を保存する「ユーザデータ案件プロパティ情報オブジェクトの配列」はデータベーステーブル
「imw_t_cpl_matter_user_data」のデータが設定されています。
ユーザデータテーブル「imw_t_cpl_matter_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_t_cpl_matter」の「USER_DATA_ID」カラムから取得します。

検索結果が存在しない場合にはdata属性にサイズ0の空オブジェクトを設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報オブジェクトの配列が設定されます。

getMatterPropertyListCount

WorkflowResultInfo getMatterPropertyListCount ()

完了案件のユーザデータ案件プロパティ情報の件数を取得します。

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

本メソッドの検索対象データベーステーブルは「imw_t_cpl_matter_user_data」です。
ユーザデータテーブル「imw_t_user_data」の検索用ユーザデータIDは案件情報テーブル
「imw_t_cpl_matter」の「USER_DATA_ID」カラムから取得します。

データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報件数(Number)が設定されます。

getNodeProgressList

WorkflowResultInfo getNodeProgressList ()

完了案件の進捗ファイル情報「progress.xml」を取得します。

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

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

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

コンストラクタに指定したシステム案件IDで案件情報の取得に失敗した場合や、
最終処理IDで「progress.xml」情報取得に失敗した場合等、進捗XML情報が取得できなかった場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ノード進捗情報オブジェクトの配列が設定されます。

getProcessHistoryLatestList

WorkflowResultInfo getProcessHistoryLatestList ()

完了案件の処理履歴の最新情報を取得します。

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

検索結果が存在しない場合にはdata属性にサイズ0の空オブジェクトを設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件処理履歴情報オブジェクトの配列が設定されます。

getProcessHistoryList

WorkflowResultInfo getProcessHistoryList ()

完了案件の処理履歴をすべて取得します。

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

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

検索結果が存在しない場合にはdata属性に「0」を設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件処理履歴情報オブジェクトの配列が設定されます。

getProcessHistoryListCount

WorkflowResultInfo getProcessHistoryListCount ()

完了案件の処理履歴件数を取得します。

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

データベースへの検索処理が失敗した場合にエラー情報を格納した結果オブジェクトを返却します。

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

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

返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、案件処理履歴情報件数(Number)が設定されます。