12.4.29 getProcessInstancesListByPIName（ビジネスプロセス定義名と案件名を指定して案件のリストを取得）
構文
java.util.List<CIWProcessInstance> getProcessInstancesListByPIName(
java.sql.Connection aDBConnection,
CIWServer aCIWServer,
java.lang.String aProcessDefinitionName,
java.lang.String aProcessInstanceName,
java.util.Set<CIWProcessInstance.State> aStates,
java.util.Set<CIWProcessInstance.AttributeName> aAttributeNames
)
throws CIWFatalException,
CIWTransientException
機能
指定したフィルター条件（ビジネスプロセス定義名，案件名，案件の状態）を満たす案件のリストを取得します。
引数
getProcessInstancesListByPINameの引数を次の表に示します。
|
項番 |
仮引数名 |
名称 |
I/O |
説明 |
|---|---|---|---|---|
|
1 |
aDBConnection |
JDBCコネクション |
in |
CIWServerオブジェクトに関連づけられたJDBCコネクションを指定します。 |
|
2 |
aCIWServer |
CIWServerオブジェクト |
in |
CIWServerオブジェクトを指定します。 |
|
3 |
aProcessDefinitionName |
ビジネスプロセス定義名 |
in |
取得したい案件のビジネスプロセス定義名を指定します。 空文字列およびnullは指定できません。 |
|
4 |
aProcessInstanceName |
案件名（案件キー） |
in |
取得したい案件の案件名を指定します。案件名が未設定の案件を取得する場合はnullを指定します。ただし，ワーク管理データベースがORACLEの場合，nullは指定できません。 空文字列は指定できません。 |
|
5 |
aStates |
案件の状態のセット |
in |
取得したい案件の状態のセットを指定します。 案件の状態をフィルター条件に指定しない場合は，サイズ0の案件の状態のセットまたはnullを指定します。案件の状態にnullは指定できません。 |
|
6 |
aAttributeNames |
属性名のセット |
in |
取得する案件属性名のセットを指定します。 取得属性名を指定しない場合は，サイズ0の属性名のセットまたはnullを指定します。取得属性名にnullは指定できません。取得属性名が指定されていない場合でも，案件のIDは必ず取得します。取得できる属性は，CIWProcessInstance.AttributeName列挙型で指定できる属性です。 |
戻り値
取得した案件のリストを返します。
例外
getProcessInstancesListByPINameで発生する例外を次の表に示します。
|
項番 |
発生する例外 |
説明 |
|---|---|---|
|
1 |
CIWFatalException |
処理を続行できない障害が発生した場合 |
|
2 |
CIWTransientException |
一時的なエラーが発生した場合 |
注意事項
-
JDBCコネクションおよびCIWServerオブジェクトにnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
JDBCコネクションおよびCIWServerオブジェクトが関連づけられていない場合の動作は保証しません。
-
ビジネスプロセス定義名に空文字列またはnullを指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
案件名に空文字列を指定した場合は，例外（java.lang.IllegalArgumentException）が発生します。
-
指定したフィルター条件を満たす案件が存在しない場合は，空のリストを返します。
-
指定したビジネスプロセス定義名が示すビジネスプロセス定義に複数のバージョンが存在する場合，すべてのバージョンが検索対象となります。