2.3.26 getStatusesUnderJobnetメソッド
(1) 説明
指定されたジョブネット直下のユニット(ジョブネットやジョブ)のユニット状態情報を取得します。
ログインしたJP1ユーザーが,指定したジョブネット直下のユニットに参照権限がない場合でも情報は取得されます。
取得できるジョブネット直下のユニット(ジョブネットやジョブ)のユニット状態情報の詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブフローの作成方法について記載している個所を参照してください。
(2) 形式
public AjsCdGetStatusesUnderJobnetResult getStatusesUnderJobnet( java.lang.String manager, java.lang.String serviceName, java.lang.Stirng unitName, java.lang.String execID, AjsCdGetStatusesUnderJobnetOption 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バイトの文字列で指定します。 指定できるユニットの種別を次に示します。それ以外の種別のユニットを指定した場合は,例外を送出します。
なお,リモートジョブネット配下のネストジョブネットは指定できません。 |
execID |
不可 |
実行IDを,文字列で指定します。 指定する形式は「@[mmmm]{A 〜 Z}nnnn」です。 |
option |
可 |
取得オプションを設定したジョブネット直下ユニット取得オプションクラスを指定します。 ジョブネット直下ユニット状態取得オプションクラスの詳細については,「3.14 ジョブネット直下ユニット状態取得オプションクラス(AjsCdGetStatusesUnderJobnetOption)」を参照してください。 本引数を省略する場合は,nullを指定してください。本引数を省略した場合は,クラスのデフォルト値が適用されます。 |
(5) 戻り値
取得したユニットの情報を,ジョブネット直下ユニット状態情報取得結果インターフェース(AjsCdGetStatusesUnderJobnetResult)を実装したクラスのインスタンスとして返却します。
(6) 例外
例外が発生した場合,このメソッドは例外クラス(AjsCdException)を送出します。
(7) 注意事項
-
このメソッドで取得した情報には,ユニット名などの定義情報は含まれません。定義情報はgetDefinitionsUnderJobnetメソッドやsearchUnitメソッドなどで取得し,ユニットIDをキーにして該当する定義を求めてください。
-
このメソッドで取得した情報には,サスペンド中に削除されたユニット情報も含まれます。