getActivityDefinitionsList
インタフェース名:CIWServer
構文
java.util.List<CIWActivityDefinition> getActivityDefinitionsList( java.lang.String aFilter, java.lang.String aSort, int aOffset, int aMaxCount, java.util.Set<CIWActivityDefinition.AttributeName> aAttributeNames ) throws CIWFatalException, CIWTransientException
機能
指定したフィルター条件を満たす業務ステップ定義オブジェクトのリストを取得します。
引数
getActivityDefinitionsListの引数を次の表に示します。
仮引数名 |
名称 |
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は必ず取得します。取得可能な属性は,CIWActivityDefinition.AttributeName列挙型で指定できる属性です。 |
戻り値
取得した業務ステップ定義オブジェクトのリストを返します。
例外
getActivityDefinitionsListで発生する例外を次の表に示します。
発生する例外 |
説明 |
---|---|
処理を続行できない障害が発生した場合 |
|
一時的なエラーが発生した場合 |
注意事項
-
指定したフィルター条件を満たす業務ステップ定義オブジェクトが存在しない場合は,空のリストが返されます。
-
不正な引数を指定した場合は,例外(java.lang.IllegalArgumentException)が発生します。
-
オフセットに0,50,100のように指定して,複数回に分けて取得した場合は,業務ステップ定義の重複や漏れが発生することがあります。