2.7.2 一覧情報取得時のフィルター条件
一覧情報取得時には情報を絞り込むためのフィルター条件を設定できます。フィルター条件は,SQLのWHERE句の形式で指定します。実際には,一覧情報を取得できるAPIで発行するSQLのWHERE句のあとに指定したフィルター条件が付加されます。
(1) 指定方法
フィルター条件指定の構文は,使用するDBMSのSQL構文に従います。
(a) 指定できる属性
フィルター条件として指定できる属性については,「付録B 参照系APIで指定できる属性」を参照してください。
なお,属性を指定する場合の注意事項を次に示します。
-
属性名は文字列で指定してください。
-
指定する属性名は,「"」(半角ダブルクォーテーション)で囲まないでください。
(b) 属性値の指定方法
-
日付データを条件に指定する場合
CIWUtilクラスのconvertDateToStringメソッドを使用します。このメソッドは,Dateオブジェクトから,フィルター条件で使用できる日付情報の値に変換した文字列を返すメソッドで,返された文字列を連結してフィルター条件を生成します。
例
SimpleDateFormat format = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss"); Date date = format.parse("2006/08/01 00:00:00"); String filterCondition = "StartDate < " + CIWUtil.convertDateToString(date);
-
状態を条件に指定する場合
フィルター条件で状態の値を使用する場合,各クラスに定義された列挙型StateのtoStateCodeメソッドを使用します。
例
String filterCondition = "StateCode = '" + CIWWorkItem.State.READY.toStateCode() + "'";
-
種類を条件に指定する場合
フィルター条件で種類の値を使用する場合,各クラスに定義された列挙型TypeのtoTypeCodeメソッドを使用します。
例
String filterCondition = "WorkTypeCode = '" + CIWWorkItem.Type.NORMAL.toTypeCode() + "'";