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); // 「０」行から
 cond.setCount(3);  // 「３」行まで
 
 

このオブジェクトが扱う定数値の詳細は以下の通りです。

• 比較演算子を表す定数
  

  利用する比較演算子	パラメータ
  =	ListSearchCondition.OP_EQ
  <=	ListSearchCondition.OP_LE
  >=	ListSearchCondition.OP_GE
  <	ListSearchCondition.OP_LT
  >	ListSearchCondition.OP_GT
  like	ListSearchCondition.OP_LIKE

  
  
  
• カラムタイプ種別を表す定数
  

  利用するカラム種別	パラメータ
  VARCHAR	ListSearchCondition.COL_VARCHAR
  DATE	ListSearchCondition.COL_DATE
  TIMESTAMP	ListSearchCondition.COL_TIMESTAMP
  NUMBER	ListSearchCondition.COL_NUMBER