2.3.29 cancelGetScheduleメソッド
(1) 説明
キャンセルを要求します。
実行中のgetScheduleメソッドでの予実績取得を中止します。
(2) 形式
- 要求IDを指定しないキャンセルの場合
public boolean cancelGetSchedule( java.lang.String manager, java.lang.String serviceName) throws AjsCdException
- 要求IDの指定によるキャンセルの場合
public boolean cancelGetSchedule( 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はgetScheduleメソッドで設定したものを指定します。 省略した場合は，getScheduleメソッドで要求IDを設定していない要求だけがキャンセルされます。 |
(5) 戻り値
キャンセル要求したかどうかをbooleanで返却します。
この値は，予実績取得をキャンセルできたかどうかではなく，予実績取得のキャンセル要求ができたかどうかを指します。
(6) 例外
例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。
(7) 注意事項
-
本APIはgetScheduleメソッドが対象となります。キャンセル対象の処理がない場合，戻り値には「false」を返却します。また，戻り値が「true」の場合でも，JP1/AJS3 - Managerのホストにキャンセル要求を送信したタイミングによっては（処理の開始前，処理の終了後など），キャンセルされないときがあります。
-
本APIとすれ違いでgetScheduleメソッドが開始した場合，処理はキャンセルされません（getScheduleメソッドは例外を送出しません）。処理をキャンセルするには，本APIを再発行してください。
-
実行中のgetScheduleメソッドをキャンセルできた場合でも，本APIは例外を送出せずに，正常終了します。なお，処理をキャンセルされたgetScheduleメソッドは例外を送出します。
-
本APIにより，実行中のgetScheduleメソッドに対して処理をキャンセルするのとほぼ同時にgetScheduleメソッドの処理が終了（cancelGetScheduleメソッドは正常終了）するケースの場合，getScheduleメソッドによるJP1/AJS3 - Managerからのデータ取得が完了しているタイミング以降では，getScheduleメソッドはメソッド内の後処理を続行して，例外を送出することなく正常終了します。
-
本APIの実行は，getScheduleメソッドと別スレッドで実行してください。