ListSearchCondition オブジェクト

検索条件オブジェクト。

検索条件になる情報を設定します。
条件を指定する際に、検索のキーは、各検索処理マネージャの検索キープロパティで指定します。

条件の追加時にはキーになるカラムとその比較対象の値、比較方法を指定します。比較方法は下記の「比較演算子を表す定数」を参照してください。

この検索条件には案件プロパティをキーとして指定することが可能です。
案件プロパティの操作には「addConditionByMatterProp」「addColumnByMatterProp」「addOrderByMatterProp」を利用します。
案件プロパティを検索条件として指定したり、取得するカラムとして指定することが可能です。 案件プロパティの指定には「ColumnType」が必要です。検索もしくはソートを行う際に、案件プロパティを文字、値、日付のどのタイプで扱うかを指定します。
下記の「カラムタイプ種別を表す定数」を参照してください。

【 各項目の必須/任意 】
レコードの取得位置またはレコードの取得件数を設定する場合、ソート条件は必須となります。

【使用例 - 「UnprocessActvMatterList」を利用する場合】
 var cond = new ListSearchCondition();
 
 // フローIDカラムが「id001」と同じものを検索
 cond.addCondition(UnprocessActvMatterList.FLOW_ID, "id001", ListSearchCondition.OP_EQ);
 // 申請基準日が「2011/01/01」より大きいものを検索
 cond.addCondition(UnprocessActvMatterList.APPLY_BASE_DATE, "2011/01/01", ListSearchCondition.OP_GT);
 // フロー名が「フロー」を含めるものを検索
 cond.addCondition(UnprocessActvMatterList.FLOW_NAME, "フロー",ListSearchCondition.OP_LIKE);
 
 // 検索した結果として案件プロパティを一緒に取得したい場合には「addColumnByMatterProp」でそのカラムのキーを指定します。
 cond.addColumnByMatterProp("key1");
 cond.addColumnByMatterProp("key2");
 
 // 「addColumnByMatterProp」追加した案件プロパティを条件式で使用した場合には「addConditionByMatterProp」で指定します。
 // 案件プロパティを指定する場合にはカラムタイプを指定する必要があります。 
 // 設定例)案件プロパティのキー「key2」が1000より大きい場合の条件を追加、ただしカラムは「文字列」として扱い検索します。
 cond.addConditionByMatterProp("key2", "1000", ListSearchCondition.OP_GT, ListSearchCondition.COL_VARCHAR);
 
 // ソート条件を指定する。フローIDで「昇順」ソートする。
 cond.addOrder(UnprocessActvMatterList.FLOW_ID, true); // true:昇順 / false:降順
 
 // 案件プロパティをソート条件として指定します。ただしカラムは「数字」として扱いソートします。
 cond.addOrderByMatterProp("key2", false, ListSearchCondition.COL_NUMBER);
 
 // データ取得の件数を絞ります。
 cond.setOffset(0); // 「0」行から
 cond.setCount(3);  // 「3」行まで
 
 

このオブジェクトが扱う定数値の詳細は以下の通りです。
導入されたバージョン:7.2

定数の概要
static String COL_DATE
カラムタイプ "DATE"
static String COL_NUMBER
カラムタイプ "NUMBER"
static String COL_TIMESTAMP
カラムタイプ "TIMESTAMP"
static String COL_VARCHAR
カラムタイプ "VARCHAR"
static String OP_EQ
比較演算子 "="
static String OP_GE
比較演算子 ">="
static String OP_GT
比較演算子 ">"
static String OP_LE
比較演算子 "<="
static String OP_LIKE
比較演算子 " like "
static String OP_LT
比較演算子 "<"

コンストラクタの概要
ListSearchCondition ()
コンストラクタ。

メソッドの概要
WorkflowResultInfo addColumnByMatterProp (String mpKeyName)
検索結果モデルに表示カラムとして追加する案件プロパティのキーを追加します。
WorkflowResultInfo addCondition (Object column ,String value ,String operatorType)
検索結果を絞り込む条件を追加します。
WorkflowResultInfo addConditionByMatterProp (String mpKeyName ,String value ,String operatorType ,String type)
検索結果を絞り込む条件として使用する案件プロパティキーを追加します。
WorkflowResultInfo addOrder (Object column ,Boolean isASC)
ソート条件を追加します。
WorkflowResultInfo addOrderByMatterProp (String mpKeyName ,boolean isASC ,String type)
案件プロパティをソート条件として追加します。
WorkflowResultInfo setAndCombination (Boolean isAndCombination)
複数条件の結合条件を設定します。
WorkflowResultInfo setCount (String count)
レコードの取得件数を設定します。
WorkflowResultInfo setOffset (String offset)
レコードの取得位置を設定します。

定数の詳細
COL_DATE

static String COL_DATE

カラムタイプ "DATE"

COL_NUMBER

static String COL_NUMBER

カラムタイプ "NUMBER"

COL_TIMESTAMP

static String COL_TIMESTAMP

カラムタイプ "TIMESTAMP"

COL_VARCHAR

static String COL_VARCHAR

カラムタイプ "VARCHAR"

OP_EQ

static String OP_EQ

比較演算子 "="

OP_GE

static String OP_GE

比較演算子 ">="

OP_GT

static String OP_GT

比較演算子 ">"

OP_LE

static String OP_LE

比較演算子 "<="

OP_LIKE

static String OP_LIKE

比較演算子 " like "

OP_LT

static String OP_LT

比較演算子 "<"

コンストラクタの詳細
ListSearchCondition

ListSearchCondition ()
コンストラクタ。

メソッドの詳細
addColumnByMatterProp

WorkflowResultInfo addColumnByMatterProp (String mpKeyName)

検索結果モデルに表示カラムとして追加する案件プロパティのキーを追加します。

検索結果モデルの内に設定される「UserMatterPropertyInfo」から指定したキーとその値が取得できまます。
ただし、キーに該当するレコードが存在しない場合や、取得した値が空文字の場合は
UserMatterPropertyInfo」に設定される「案件プロパティ値」は「null」になります。

パラメータ
mpKeyName String 案件プロパティキー
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

addCondition

WorkflowResultInfo addCondition (Object column ,String value ,String operatorType)

検索結果を絞り込む条件を追加します。

指定したカラムを検索条件として追加したい場合に利用します。
指定できるカラムは各検索処理マネージャのプロパティで定義されています。
他に案件プロパティを検索キーで使用する場合には「addConditionByMatterProp(String, String, String, String)」を利用する必要があります。
パラメータ
column Object カラム
value String
operatorType String 比較演算子
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

addConditionByMatterProp

WorkflowResultInfo addConditionByMatterProp (String mpKeyName ,String value ,String operatorType ,String type)

検索結果を絞り込む条件として使用する案件プロパティキーを追加します。

案件プロパティはデータベースでは文字列で保存されています。
比較演算子が大小の比較の場合は、案件プロパティ値の型が文字か数字かによって、取得結果が異なる場合があります。
パラメータ
mpKeyName String 案件プロパティキー
value String 比較値
operatorType String 比較演算子
type String 案件プロパティ値の型
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

addOrder

WorkflowResultInfo addOrder (Object column ,Boolean isASC)

ソート条件を追加します。

指定したカラムをソート条件として追加したい場合に利用します。
指定できるカラムは各検索処理マネージャのプロパティで定義されています。
他に案件プロパティをソートキーで使用する場合には「addOrderByMatterProp(String, boolean, String)」を利用する必要があります。
パラメータ
column Object カラム
isASC Boolean true:昇順 / false:降順
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

addOrderByMatterProp

WorkflowResultInfo addOrderByMatterProp (String mpKeyName ,boolean isASC ,String type)

案件プロパティをソート条件として追加します。

案件プロパティはデータベースでは文字列で保存されていますが、
その文字をソートする際に、数字や日付として扱う必要がある場合は、案件プロパティ値の型で指定することができます。
パラメータ
mpKeyName String 案件プロパティキー
isASC boolean true:昇順 / false:降順
type String 案件プロパティ値の型
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

setAndCombination

WorkflowResultInfo setAndCombination (Boolean isAndCombination)

複数条件の結合条件を設定します。
複数の条件を指定した場合に、条件間の結合タイプを「AND」か「OR」で指定します。
各条件の結合は「AND」か「OR」のどちらかに統一されます。
パラメータ
isAndCombination Boolean true:AND結合 / false:OR結合
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

setCount

WorkflowResultInfo setCount (String count)

レコードの取得件数を設定します。
パラメータ
count String レコードの取得件数
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

setOffset

WorkflowResultInfo setOffset (String offset)

レコードの取得位置を設定します。
パラメータ
offset String レコードの取得位置
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。