Hitachi

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


2.3.24 getCurrentStatusesUnderJobGroupメソッド

〈この項の構成〉

(1) 説明

指定されたジョブグループ直下のユニット(ジョブグループ,ジョブネット,またはジョブ)のユニット定義情報,最新状態情報,および最新結果情報を取得します。

ログインしたJP1ユーザーが,指定したジョブグループ直下のユニットに参照権限がない場合でも情報は取得されます。

最新状態としてどの世代の実行状態が取得されるかは,要求を依頼するJP1/AJS3 - Managerの環境設定パラメーター「VIEWSTATUSRANGE」の設定値に従います。

詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド」の[JP1/AJS3 - View]ウィンドウでの監視のリストエリアについて記載している個所を参照してください。

取得できるジョブグループ直下のユニット(ジョブグループ,ジョブネット,またはジョブ)のユニット定義情報,最新状態情報,および最新結果情報の詳細については,マニュアル「JP1/Automatic Job Management System 3 操作ガイド」のJP1/AJS3 - View で使用するウィンドウおよびダイアログボックスのカスタマイズで,メイン画面のリストエリアについて記載している個所を参照してください。

(2) 形式

public AjsCdGetCurrentStatusesUnderJobGroupResult getCurrentStatusesUnderJobGroup(
  java.lang.String manager,
  java.lang.String serviceName,
  java.lang.Stirng unitName,
  AjsCdGetCurrentStatusesUnderJobGroupOption option) throws AjsCdException

(3) 実行権限

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

(4) 引数

引数名

省略

説明

manager

不可

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

serviceName

不可

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

unitName

不可

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

指定できるユニットの種別を次に示します。

  • ジョブグループ

  • プランニンググループ

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

option

取得オプションを設定したジョブグループ直下ユニット取得オプションクラスを指定します。

ジョブグループ直下ユニット取得オプションクラスの詳細については,「3.9 ジョブグループ直下ユニット取得オプションクラス(AjsCdGetCurrentStatusesUnderJobGroupOption)」を参照してください。

本引数を省略する場合はnullを指定してください。本引数を省略した場合は,クラスのデフォルト値が適用されます。

(5) 戻り値

取得した結果を,ジョブグループ直下ユニット取得結果インターフェース(AjsCdGetCurrentStatusesUnderJobGroupResult)を実装したクラスのインスタンスとして返却します。

(6) 例外

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

(7) 注意事項