jp.co.intra_mart.foundation.workflow.application.general

クラス RefCplMatterList

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.system.workflow.api.database.AbstractMatterListDaoBase

jp.co.intra_mart.foundation.workflow.application.general.RefCplMatterList

public class RefCplMatterList
extends jp.co.intra_mart.system.workflow.api.database.AbstractMatterListDaoBase

参照一覧（完了）マネージャ。

完了案件に対して、コンストラクタで指定した特定ユーザが参照できる案件の一覧を取得します。

特定のユーザをコンストラクタに設定せずに、ワークフロー運用管理者として全ての案件を参照したい場合は、
管理者クラスである「RefCplMatterAdminList」を利用してください。

本クラスでは「imw_t_cpl」で始まるトランザクション系の完了案件関連テーブルから情報を取得します。

処理中の未完了した案件に対して、参照一覧を取得するには「RefActvMatterList」を利用してください。

導入されたバージョン:

7.2

バージョン:

8.0.22

関連項目:

RefActvMatterList, RefCplMatterAdminList

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

クラスから継承されたネストされたクラス/インタフェース 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

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected String	getColumnNameWithTableName(String columnName) WHERE句に指定するカラム名を取得します。
protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql	getPropertyTable() 案件プロパティ（ユーザデータ）テーブルを取得します。
CplMatterRefModel[]	getRefList(ListSearchCondition<CplMatterType> cond) コンストラクタで指定した特定ユーザが参照できる完了案件一覧を取得します。
int	getRefListCount(ListSearchCondition<CplMatterType> cond) コンストラクタで指定した特定ユーザが参照できる完了案件の件数を取得します。
Map<String,Integer>	getRefListCountForEachFlow() コンストラクタで指定した特定ユーザが参照できる完了案件の件数を取得します。
protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql	getSearchMainTable() 検索メイン用テーブルを取得します。

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

appendSearchConditionInner, createPreSQL, executeCount, executeSearch

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

appendOrderCondition, checkJoinFlowGrpQuery, checkJoinFlowGrpQueryNoMatterProp, executeCount, executeCount, executeCount, executeCountForEachFlow, 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

コンストラクタの詳細

RefCplMatterList

public RefCplMatterList(String userCd)

コンストラクタ。
引数で指定した実行者コードで参照一覧（完了）マネージャを
新しく生成します。

パラメータ:

userCd - 参照者コード

RefCplMatterList

public RefCplMatterList(String userCd,
                        String localeId)

コンストラクタ。
引数で指定した実行者コード、ロケールIDで参照一覧（完了）マネージャを
新しく生成します。

パラメータ:

userCd - 参照者コード

localeId - ロケールID

RefCplMatterList

@Deprecated
public RefCplMatterList(String userCd,
                                    String loginGroupId,
                                    String localeId)

非推奨です。 RefCplMatterList(String, String) を使用してください。

コンストラクタ。
引数で指定した実行者コード、ログイングループID、ロケールIDで参照一覧（完了）マネージャを
新しく生成します。

パラメータ:

userCd - 参照者コード

loginGroupId - ログイングループID

localeId - ロケールID

メソッドの詳細

getRefList

public CplMatterRefModel[] getRefList(ListSearchCondition<CplMatterType> cond)
                               throws WorkflowException

コンストラクタで指定した特定ユーザが参照できる完了案件一覧を取得します。

検索条件を設定する為の引数である「cond 検索条件」の設定は必須です。
特に検索条件を設定する必要がない場合でもインスタンスを作成して設定する必要があります。
検索結果が存在しない場合にはサイズ０の空オブジェクトを返却します。

データベースへの検索処理で失敗した場合には「WorkflowException」が発生します。

IM-Workflowのシステム設定の「threadの設定」が非同期（標準）である場合に、
本メソッドで取得される一覧には、処理中である案件は含まれていません。
到達処理又は案件終了処理が実行中である案件は取得対象から除外されます。

結果を保存する「完了案件情報（参照用）」には設定される情報の中、
参照権限者情報は「imw_t_cpl_matter_handle_user」から取得します。
案件情報は「imw_t_cpl_matter」「imw_t_cpl_matter_locale」から取得します。

検索条件や、ソート条件の設定は「CplMatterTypeに定義されているEnumをキーで設定できます。
ユーザデータ案件プロパティを取得一覧として取得する条件設定をした場合に、値を取得する対象テーブルは「imw_t_cpl_matter_user_data」になります。
詳しい使用方法は「ListSearchCondition」を参照してください。

処理中の未完了案件の参照一覧を取得するには「RefActvMatterList.getRefList(ListSearchCondition)」を利用してください。

パラメータ:

cond - 検索条件

戻り値:

CplMatterRefModel[] 完了案件情報（参照用）の配列

例外:

WorkflowException - ワークフロー例外の親クラス

getRefListCount

public int getRefListCount(ListSearchCondition<CplMatterType> cond)
                    throws WorkflowException

コンストラクタで指定した特定ユーザが参照できる完了案件の件数を取得します。

検索条件を設定する為の引数である「cond 検索条件」の設定は必須です。
特に検索条件を設定する必要がない場合でもインスタンスを作成して設定する必要があります。

データベースへの検索処理で失敗した場合には「WorkflowException」が発生します。

IM-Workflowのシステム設定の「threadの設定」が非同期（標準）である場合に、
本メソッドで取得される一覧には、処理中である案件は含まれていません。
到達処理又は案件終了処理が実行中である案件は取得対象から除外されます。

参照権限者情報を検索する対象テーブルは「imw_t_cpl_matter_handle_user」になります。
案件情報を検索する対象テーブルは「imw_t_cpl_matter」「imw_t_cpl_matter_locale」になります。

検索条件や、ソート条件の設定は「ActvMatterTypeに定義されているEnumをキーで設定できます。
ユーザデータ案件プロパティを取得一覧として取得する条件設定をした場合に、値を取得する対象テーブルは「imw_t_cpl_matter_user_data」になります。
詳しい使用方法は「ListSearchCondition」を参照してください。

処理中の未完了案件の参照一覧の件数を取得するには「RefActvMatterList.getRefListCount(ListSearchCondition)」を利用してください。

パラメータ:

cond - 検索条件

戻り値:

int 完了案件情報件数

例外:

WorkflowException - ワークフロー例外の親クラス

getRefListCountForEachFlow

public Map<String,Integer> getRefListCountForEachFlow()
                                               throws WorkflowException

コンストラクタで指定した特定ユーザが参照できる完了案件の件数を取得します。

キーがフローID、値がフローID毎の完了案件情報件数のマップを返却します。

戻り値:

Map キーがフローID、値がフローID毎の完了案件情報件数のマップ

例外:

WorkflowException - ワークフロー例外の親クラス

導入されたバージョン:

8.0.22

getColumnNameWithTableName

protected String getColumnNameWithTableName(String columnName)

WHERE句に指定するカラム名を取得します。
JOINするテーブル間で同じ名称のカラムが複数存在する場合は、引数のカラム名にテーブル名を付加した文字列を返却します。

定義:

getColumnNameWithTableName クラス内 jp.co.intra_mart.system.workflow.api.database.AbstractMatterListDaoBase

パラメータ:

columnName - カラム名

戻り値:

対象のカラムにテーブル名が必要な場合はテーブル名付きのカラム名（テーブル名.カラム名）、それ以外は引数のカラム名をそのまま返却します

導入されたバージョン:

8.0.11

getPropertyTable

protected jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql getPropertyTable()

案件プロパティ（ユーザデータ）テーブルを取得します。

定義:

getPropertyTable クラス内 jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

戻り値:

SubSearchSql 案件プロパティ（ユーザデータ）テーブル

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例外クラス

導入されたバージョン:

7.2