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