Hitachi

JP1 Version 10 JP1/Automatic Job Management System 3 - Software Development Kit APIリファレンス


2.3.30 getCalendarメソッド

〈この項の構成〉

(1) 説明

指定されたジョブグループやルートジョブネットのカレンダー情報を取得します。

ルートジョブネットを指定した場合は,上位のジョブグループのカレンダー情報が取得されます。

取得できる情報は,上位のすべてのジョブグループのカレンダー情報がマージされた情報です。

スケジュールルールの[他のジョブグループのカレンダーを参照]を設定していても,参照先のジョブグループの情報には適用されません。

年月を指定して情報を取得する場合,取得できる範囲は,基準日から翌月の基準日の前日までです。

例えば,2012年12月を指定して本メソッドを呼び出した場合,基準日の指定により,取得できる範囲は次のようになります。

基準日が1日,月区分が当月の場合

取得できる範囲:12/1〜12/31

基準日が第2週目の水曜日,月区分が当月の場合

取得できる範囲:12/12〜1/8

ジョブグループやルートジョブネットのカレンダー情報の詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のJP1/AJS3運用上のカレンダー定義について記載している個所を参照してください。

(2) 形式

年月を指定して情報を取得する場合
public AjsCdCalendar getCalendar(
  java.lang.String manager,
  java.lang.String serviceName,
  java.lang.String unitName,
  java.lang.String month) throws AjsCdException
期間を指定して情報を取得する場合
public AjsCdCalendar getCalendar(
  java.lang.String manager,
  java.lang.String serviceName,
  java.lang.String unitName,
  java.lang.String begin,
  java.lang.String end) throws AjsCdException

(3) 実行権限

ログインしたJP1ユーザーが,ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。

(4) 引数

引数名

省略

説明

manager

不可

要求を依頼するJP1/AJS3 - Managerのホスト名を,1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。

serviceName

不可

要求対象のスケジューラーサービス名を,1〜30バイトの文字列で指定します。

unitName

不可

情報を取得するユニットの完全名を,1〜930バイトの文字列で指定します。

指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は,例外を送出します。

  • ジョブグループ

  • プランニンググループ

  • ルートジョブネット

  • ルートリモートジョブネット

なお,マネージャージョブグループは指定できません。

month

不可

取得したいカレンダー情報の年月を,「YYYYMM」形式の文字列で指定します。指定できる値を次に示します。

  • YYYY:年を指定します。年に指定できる値は,1994〜2036(単位:年)です。

  • MM:月を指定します。月に指定できる値は,01〜12(単位:月)です。

指定する年月は,要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

begin

不可

取得するカレンダー情報の開始日を,「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

  • YYYY:年を指定します。年に指定できる値は,1994〜2036(単位:年)です。

  • MM:月を指定します。月に指定できる値は,01〜12(単位:月)です。

  • DD:日にちを指定します。日にちに指定できる値は,01〜31(単位:日)です。

指定する日付は,要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

end

不可

取得するカレンダー情報の終了日を,「YYYYMMDD」形式の文字列で指定します。指定できる値を次に示します。

  • YYYY:年を指定します。年に指定できる値は,1994〜2036(単位:年)です。

  • MM:月を指定します。月に指定できる値は,01〜12(単位:月)です。

  • DD:日にちを指定します。日にちに指定できる値は,01〜31(単位:日)です。

指定する日付は,要求先JP1/AJS3 - Managerが認識する年月日で指定してください。

なお,本引数には引数beginで指定した日付以降の値を指定してください。それ以外の値を指定した場合は,例外を送出します。

(5) 戻り値

取得したカレンダー情報を,カレンダー情報インターフェース(AjsCdCalendar)を実装したクラスのインスタンスとして返却します。

(6) 例外

例外が発生した場合,このメソッドは例外クラス(AjsCdException)を送出します。