getWorkItemsList
インタフェース名:CIWServer
構文
java.util.List<CIWWorkItem> getWorkItemsList( java.lang.String aFilter, java.lang.String aSort, int aOffset, int aMaxCount, java.util.Set<CIWWorkItem.AttributeName> aAttributeNames ) throws CIWFatalException, CIWTransientException
機能
指定したフィルター条件を満たす作業オブジェクトのリストを取得します。
引数
getWorkItemsListの引数を次の表に示します。
仮引数名 |
名称 |
in/out |
説明 |
---|---|---|---|
aFilter |
フィルター条件 |
in |
作業を取得する場合のフィルター条件を指定します。 フィルター条件を指定しない場合は,nullを指定します。 フィルター条件の指定方法については,「付録B 参照系APIで指定できる属性」を参照してください。 |
aSort |
ソート条件 |
in |
作業を取得する場合のソート条件を指定します。 ソート条件を指定しない場合は,nullを指定します。 ソート条件の指定方法については,「付録B 参照系APIで指定できる属性」を参照してください。 |
aOffset |
オフセット |
in |
作業を取得する場合のオフセットを指定します。 オフセットは先頭を0として指定します。0未満の値は指定できません。 |
aMaxCount |
最大取得数 |
in |
作業を取得する場合の最大取得数を指定します。 すべてを取得する場合は,-1を指定します。-1未満の値は指定できません。 |
aAttributeNames |
属性名のセット |
in |
取得したい作業の属性名のセットを指定します。 取得属性名を指定しない場合は,サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名に指定していない場合でも,作業のIDと作業が所属する案件のIDは必ず取得します。取得できる属性は,CIWWorkItem.AttributeName列挙型で指定できる属性です。 |
戻り値
取得した作業オブジェクトのリストを返します。
例外
getWorkItemsListで発生する例外を次の表に示します。
発生する例外 |
説明 |
---|---|
処理を続行できない障害が発生した場合 |
|
一時的なエラーが発生した場合 |
注意事項
-
指定したフィルター条件を満たす作業オブジェクトが存在しない場合は,空のリストが返されます。
-
不正な引数を指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
オフセットに0,50,100などを指定し,複数回に分けて取得した場合は,作業の重複や漏れが発生することがあります。