2.3.28 getScheduleメソッド
(1) 説明
指定されたジョブネットの，ジョブネットやジョブの実行予実績や実行状態を取得します。実行予定は擬似予定も取得できます。
本メソッドはcancelGetScheduleメソッドでキャンセルすることができます。cancelGetScheduleメソッドでキャンセルする処理を特定したいときは，要求IDを指定して呼び出してください。
ログインしたJP1ユーザーに参照権限がないユニットが存在する場合は，すべてのユニットの情報を取得できません。参照権限がないユニットが存在した場合は，例外を送出します。
ジョブネットの，ジョブネットやジョブの実行予実績や実行状態の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の実行予定の確認について記載している個所，およびマニュアル「JP1/Automatic Job Management System 3 設計ガイド（業務設計編）」の2日にまたがる業務のスケジュールを立てる方法について記載している個所を参照してください。
(2) 形式
- 要求IDを設定しない場合
public AjsCdGetScheduleResult getSchedule( java.lang.String manager, java.lang.String serviceName, java.lang.String unitName, long begin, long end, DateType dateType, java.lang.String releaseID, AjsCdGetScheduleOption option) throws AjsCdException
- 要求IDを設定する場合（キャンセルで要求を区別する場合）
public AjsCdGetScheduleResult getSchedule( java.lang.String manager, java.lang.String serviceName, java.lang.String unitName, long begin, long end, DateType dateType, java.lang.String releaseID, java.lang.String id, AjsCdGetScheduleOption option) 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バイトの文字列で指定します。 |
|
unitName |
不可 |
情報を取得するユニットの完全名を，1〜930バイトの文字列で指定します。 指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は，例外を送出します。
|
|
begin※ |
不可 |
スケジュールを取得する期間の開始時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。 指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。 なお，本引数には引数endで指定した時間以前の値を指定してください。それ以外の値を指定した場合は，例外を送出します。 |
|
end※ |
不可 |
スケジュールを取得する期間の終了時間を1970年1月1日0時0分0秒（UTC形式）からの経過時間（64ビット）のミリ秒単位で指定します。ただし，ミリ秒の指定は切り捨てて無視します（秒の値までが有効となります）。 指定できる範囲は1994/1/1〜2036/12/31です。それ以外の値を指定した場合の動作は保証しません。 なお，本引数には引数beginで指定した時間以降の値を指定してください。それ以外の値を指定した場合は，例外を送出します。 |
|
dateType |
不可 |
スケジュールを取得する期間の指定が暦日か実行日かを指定します。 指定できる値と内容については，「付録A.9 (2)DateType」を参照してください。 なお，「EXECUTION_DATE（実行日）」を指定した場合，引数begin（開始時間）と引数end（終了時間）で指定する期間は日単位（基準時刻からの1日）で扱われます。1日未満で基準時刻を含まない日のスケジュールは取得されませんので，取得対象日の基準時刻が含まれるように指定してください。 |
|
releaseID |
可 |
リリースIDを，1〜30バイトの文字列で指定します。 本引数は，ジョブネットリリース機能を使用している場合に，リリースIDに対応したユニットの予実績情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。 本引数を指定した場合は，指定したリリースIDに対応したユニットの予実績情報を取得します。 本引数を省略した場合は，本メソッドを呼び出した時点で適用されているユニットの予実績情報を取得します。 本指定は，接続先JP1/AJS3 - Managerが標準構成の場合にだけ有効です。それ以外の場合は本指定は無視されます（指定がなかった場合と同じ動作をします）。 |
|
id |
可 |
APIの要求を識別するための文字列（要求ID）を1〜2,048バイトで指定します。バイト数は本製品が動作するJavaのデフォルトエンコーディングでのバイト数となります。 要求IDは，cancelGetScheduleメソッドでキャンセルする処理を特定したい場合に指定します。 要求IDを指定した場合，cancelGetScheduleメソッドの引数に同じ要求IDを指定することで，本メソッドの処理だけをキャンセルすることができます。 要求IDを省略した場合，cancelGetScheduleメソッドの引数に要求IDを指定しないことで，本メソッドの処理をキャンセルすることができます。 キャンセルの詳細については，「2.3.29 cancelGetSheduleメソッド」を参照してください。 |
|
option |
可 |
取得オプションを設定した予実績情報取得オプションクラスを指定します。 予実績情報取得オプションクラスの詳細については，「3.18 予実績情報取得オプションクラス（AjsCdGetScheduleOption）」を参照してください。 本引数を省略する場合は，nullを指定してください。本引数を省略した場合は，クラスのデフォルト値が適用されます。 |
- 注※
-
例えば，引数beginと引数endで指定する範囲を1日とする場合は次のように指定します。なお，基準時間はgetCalendarメソッドで取得してください。
- 引数beginに指定する値
-
取得対象日のミリ秒値 + 基準時間のミリ秒値
- 引数endに指定する値
-
引数beginに指定した値 + 1日のミリ秒値（1日を23時間59分59秒とする場合は((24×60×60)−1)×1000ミリ秒）
(5) 戻り値
取得したユニットの情報を，ジョブネットの予実績情報取得結果インターフェース（AjsCdGetScheduleResult）を実装したクラスのインスタンスとして返却します。
(6) 例外
-
例外が発生した場合，このメソッドは例外クラス（AjsCdException）を送出します。
-
cancelGetScheduleメソッドによってキャンセルされた場合，例外クラス（AjsCdApiCancelException）を送出します。
(7) 注意事項
-
このメソッドで取得した情報には，ユニット名などの定義情報は含まれません。定義情報はgetDefinitionsUnderJobnetメソッドやsearchUnitメソッドなどで取得し，ユニットIDをキーにして該当する定義を求めてください。
-
予実績情報の取得は，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Managerに負荷がかかることがあります。JP1/AJS3 - Managerへの負荷を考慮して，取得する期間を検討してください。
-
本メソッドは，取得対象の世代数や対象ジョブネットの総ユニット数によって，JP1/AJS3 - Manager やネットワークに負荷がかかることがあります。また，世代数や対象ジョブネットの総ユニット数が増えるに従い，所要メモリ量と応答時間が増加します。
世代数や対象ジョブネットの総ユニット数が多い場合は，１回あたりの取得期間を複数回に短く分割して取得するなどを検討してください。