2.3.25 getDefinitionsUnderJobnetメソッド
(1) 説明
指定されたジョブネット直下のユニット(ジョブネットやジョブ)のユニット定義情報を取得します。
ログインしたJP1ユーザーが,指定したジョブネット直下のユニットに参照権限がない場合でも情報は取得されます。
取得できるジョブネット直下のユニット(ジョブネットやジョブ)のユニット定義情報の詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブフローの作成方法について記載している個所を参照してください。
(2) 形式
public AjsCdGetDefinitionsUnderJobnetResult getDefinitionsUnderJobnet( java.lang.String manager, java.lang.String serviceName, java.lang.Stirng unitName, java.lang.String execID, java.lang.String releaseID) 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」です。 本引数は,ジョブネットリリース機能を使用している場合に,実行IDの世代に対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。 |
releaseID※ |
可 |
リリースIDを,1〜30バイトの文字列で指定します。 本引数は,ジョブネットリリース機能を使用している場合に,リリースIDに対応したユニット定義情報を取得するときに指定します。本引数を省略する場合はnullを指定してください。 本指定は,接続先JP1/AJS3 - Managerが標準構成の場合にだけ有効です。それ以外の場合は本指定は無視されます(指定がなかった場合と同じ動作をします)。 |
- 注※
-
実行IDとリリースIDは同時に指定できません。同時に指定した場合は,例外を送出します。どちらも省略した場合は,本メソッドを呼び出した時点で適用されているユニット定義情報を取得します。
(5) 戻り値
取得したユニットの情報を,ジョブネット直下ユニット定義情報取得結果インターフェース(AjsCdGetDefinitionsUnderJobnetResult)を実装したクラスのインスタンスとして返却します。
(6) 例外
例外が発生した場合,このメソッドは例外クラス(AjsCdException)を送出します。
(7) 注意事項
本メソッドの引数に起動条件付きのルートジョブネットを指定すると,配下ユニットの一覧に起動条件が含まれます。また,この場合,起動条件ユニットの座標位置はX座標0,Y座標0が固定で設定されます。
位置情報と関連線を使用して図を描く場合の詳細については,マニュアル「JP1/Automatic Job Management System 3 - Software Development Kit 設計・構築ガイド」のジョブの実行ステータスをジョブフロー形式で監視する画面の「マップ表示」について記載している個所を参照してください。