2.3.19 searchUnitメソッド
(1) 説明
ユニット一覧を取得します。
指定されたユニット，またはユニット配下の，ジョブグループ，ジョブネットまたはジョブの情報を取得します。取得するユニットは，検索条件を指定して取得します。条件を複数指定した場合，条件をすべて満たすユニットの一覧が取得されます。ログインしたJP1ユーザーに参照権限がないユニットの情報は取得できません。
取得できるユニットの詳細については，マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のユニットの検索について記載している個所を参照してください。
(2) 形式
- 要求IDを設定しない場合
public AjsCdSearchResult searchUnit( java.lang.String manager, java.lang.String serviceName, AjsCdSearchCondition searchCondition) throws AjsCdException
- 要求IDを設定する場合（キャンセルで要求を区別する場合）
public AjsCdSearchResult searchUnit( java.lang.String manager, java.lang.String serviceName, java.lang.String id, AjsCdSearchCondition searchCondition) throws AjsCdException
(3) 実行権限
ログインしたJP1ユーザーが，ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。
-
JP1_AJS_Admin権限
-
JP1_AJS_Manager権限
-
JP1_AJS_Editor権限
-
JP1_AJS_Operator権限
-
JP1_AJS_Guest権限
(4) 引数
|
引数名 |
省略 |
説明 |
|---|---|---|
|
manager |
不可 |
要求を依頼するJP1/AJS3 - Managerのホスト名を，1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。 |
|
serviceName |
不可 |
要求対象のスケジューラーサービス名を，1〜30バイトの文字列で指定します。 |
|
id |
可 |
APIの要求を識別するための文字列（要求ID）を1〜2,048バイトで指定します。バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。 要求IDは，cancelSearchメソッドでキャンセルする処理を特定したい場合に指定します。 要求IDを指定した場合， cancelSearchメソッドの引数に同じ要求IDを指定することで，本メソッドの処理だけをキャンセルすることができます。 要求IDを省略した場合，cancelSearchメソッドの引数に要求IDを指定しないことで，本メソッドの処理をキャンセルすることができます。 キャンセルの詳細については，「2.3.20 cancelSearchメソッド」を参照してください。 |
|
searchCondition |
不可 |
検索条件を指定した，ユニット検索条件クラスを指定します。 ユニット検索条件クラスの詳細については，「3.7 ユニット検索条件クラス（AjsCdSearchCondition）」を参照してください。 |
(5) 戻り値
取得したユニットの情報を，ユニット検索結果インターフェース（AjsCdSearchResult）を実装したクラスのインスタンスとして返却します。
(6) 例外
-
例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。
-
cancelSearchメソッドによってキャンセルされた場合，例外クラス（AjsCdApiCancelException）を送出します。