2.3.20 cancelSearchメソッド
(2) 形式
- 要求IDを指定しないキャンセルの場合
public boolean cancelSearch( java.lang.String manager, java.lang.String serviceName) throws AjsCdException
- 要求IDの指定によるキャンセルの場合
public boolean cancelSearch( java.lang.String manager, java.lang.String serviceName, java.lang.String id) throws AjsCdException
(3) 実行権限
なし。
(4) 引数
引数名 |
省略 |
説明 |
---|---|---|
manager |
不可 |
要求を依頼するJP1/AJS3 - Managerのホスト名を,1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。 |
serviceName |
不可 |
要求対象のスケジューラーサービス名を,1〜30バイトの文字列で指定します。 |
id |
可 |
要求IDを指定してキャンセルする場合に指定します。 要求IDはsearchUnitメソッドで設定したものを指定します。 省略した場合は,searchUnitメソッドで要求IDを設定していない要求だけがキャンセルされます。 |
(5) 戻り値
キャンセル要求したかどうかをbooleanで返却します。
この値は,ユニット一覧取得をキャンセルできたかどうかではなく,ユニット一覧取得のキャンセル要求ができたかどうかを指します。
(6) 例外
例外が発生した場合,このメソッドは例外クラス(AjsCdException)を送出します。
(7) 注意事項
-
本APIはsearchUnitメソッドが対象となります。キャンセル対象の処理がない場合,戻り値には「false」を返却します。また,戻り値が「true」の場合でも,JP1/AJS3 - Managerのホストにキャンセル要求を送信したタイミングによっては(処理の開始前,処理の終了後など),キャンセルされないときがあります。
-
本APIとすれ違いでsearchUnitメソッドが開始した場合,処理はキャンセルされません(searchUnitメソッドは例外を送出しません)。処理をキャンセルするには,本APIを再発行してください。
-
実行中のsearchUnitメソッドをキャンセルできた場合でも,本APIは例外を送出せずに,正常終了します。なお,処理をキャンセルされたsearchUnitメソッドは例外を送出します。
-
本APIにより,実行中のsearchUnitメソッドに対して処理をキャンセルするのとほぼ同時にsearchUnitメソッドの処理が終了(cancelSearchメソッドは正常終了)するケースの場合,searchUnitメソッドによるJP1/AJS3 - Managerからのデータ取得が完了しているタイミング以降では,searchUnitメソッドはメソッド内の後処理を続行して,例外を送出することなく正常終了します。
-
本APIの実行は,searchUnitメソッドと別スレッドで実行してください。