2.3.4 registerImmediateExecメソッド
(1) 説明
指定されたジョブネットを即時実行登録します。
取得した実行IDは,即時実行登録したジョブネットに対する強制終了API(「2.3.17 killメソッド」)や,実行状態や実行結果の詳細情報取得API(「2.3.21 getUnitStatusメソッド」)などで使用できます。
即時実行登録できるジョブネットの詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド」のジョブネットの実行登録について記載している個所を参照してください。
(2) 形式
public java.lang.String registerImmediateExec( java.lang.String manager, java.lang.String serviceName, java.lang.String unitName, AjsCdStartCondition startCondition, AjsCdMacroVariableList macro) throws AjsCdException
(3) 実行権限
ログインしたJP1ユーザーが,ユニットに対して次に示すJP1権限レベルのどれかを与えられている必要があります。
-
JP1_AJS_Admin権限
-
JP1_AJS_Manager権限
-
JP1_AJS_Operator権限
(4) 引数
引数名 |
省略 |
説明 |
---|---|---|
manager |
不可 |
要求を依頼するJP1/AJS3 - Managerのホスト名を,1〜255バイトの文字列で指定します。loginメソッドの第1引数に指定した値と合わせてください。 |
serviceName |
不可 |
要求対象のスケジューラーサービス名を,1〜30バイトの文字列で指定します。 |
unitName |
不可 |
要求対象のジョブネット(ユニット)の完全名を,1〜930バイトの文字列で指定します。 |
startCondition |
可 |
起動条件を使ってジョブネットを実行する場合,起動条件クラスを指定します。 起動条件を使用しない場合は,nullを指定してください。 設定の詳細については,「3.4 起動条件クラス(AjsCdStartCondition)」を参照してください。なお,オペレーションネットの場合は起動条件を指定できないため,nullを指定してください。起動条件が指定されている場合は,引数エラーとして例外を発生させます。 |
macro |
可 |
ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を,マクロ変数リストクラスで指定します。 設定の詳細については,「3.5 マクロ変数リストクラス(AjsCdMacroVariableList)」を参照してください。 マクロ変数を引き継がない場合は「null」を指定してください。 |
(5) 戻り値
実行IDを「@[mmmm]{A〜Z}nnnn」の形式で返却します。起動条件を指定している場合は監視世代の実行IDを返却します。
(6) 例外
例外が発生した場合,このメソッドは例外クラス(AjsCdException)を送出します。