4.2.4 ジョブ情報クラスAjsWsSubjobInfo

ジョブ情報クラスは,ジョブ制御クラスのジョブ実行状況監視の結果を保持するクラスです。ジョブ情報クラスのインスタンスは,ジョブ制御クラスのsubJobgetメソッドで取得できます。

ジョブ情報クラスインターフェースの詳細を次に示します。

クラス定義
public class AjsWsSubjobInfo
パッケージ名
jp.co.Hitachi.soft.ajs2.ws.jobcontrol
メソッド一覧
メソッド名説明
getQueueNameキュー名を取得します。
getJobIdジョブ番号を取得します。
getStatusジョブの状態を取得します。
getExitCodeジョブの終了コードを取得します。
getSubmitTimeジョブが登録された日時を取得します。
getStartTimeジョブ実行開始日時を取得します。
getEndTimeジョブ実行終了日時を取得します。
getJobNameジョブ名称を取得します。

各メソッドの詳細を説明します。

<この項の構成>
(1) getQueueNameメソッド
(2) getJobIdメソッド
(3) getStatusメソッド
(4) getExitCodeメソッド
(5) getSubmitTimeメソッド
(6) getStartTimeメソッド
(7) getEndTimeメソッド
(8) getJobNameメソッド

(1) getQueueNameメソッド

説明
ジョブを投入したキュー名を取得します。
形式

public java.lang.String getQueueName()

引数
なし
戻り値
キュー名を1~63バイトの文字列で返却します。
例外
なし

(2) getJobIdメソッド

説明
ジョブ番号を取得します。
形式

public int getJobId()

引数
なし
戻り値
ジョブ番号を整数値で返却します。
例外
なし

(3) getStatusメソッド

説明
ジョブの状態を取得します。
形式

public int getStatus()

引数
なし
戻り値
ジョブの状態を整数定数で返却します。返却される定数一覧を次の表に示します。

表4-9 定数一覧(ジョブの状態)

定数名説明
intEND_IN_ANOTHER_SYSTEMほかのシステムで終了状態(詳細情報が取得できなかった)
intWAITING実行待ち
intHOLDING保留中
intSCHEDULED時間待ち
intEXECUTING実行中
intNORMAL_END正常終了
intWARNING_END警告終了
intABNORMAL_END異常終了
intEXECUTION_TIMED_OUT実行打ち切り終了
intCANCELED_ENDキャンセル終了(実行開始前にキャンセルを要求した)
intFORCIBLY_TERMINATED強制終了(実行開始後にキャンセルを要求した)
intFAILURE_WHILE_STARTING_EXECUTION実行開始中の失敗
intFAILURE_WHILE_ENDING_EXECUTION実行終了中の失敗
例外
なし

(4) getExitCodeメソッド

説明
ジョブの終了コードを取得します。
形式

public int getExitCode()

引数
なし
戻り値
ジョブの終了コードを整数値で返却します。
ジョブが終了していない場合は,getExitCodeメソッドは0を返却します。
ジョブが終了している場合は,ジョブが設定した終了コード,マニュアル「JP1/Automatic Job Management System 3 設計ガイド(業務設計編)」,またはマニュアル「JP1/Automatic Job Management System 2 設計・運用ガイド」のジョブの終了コードの確認について記載している個所の説明に従って設定されたジョブの終了コードを返却します。
例外
なし

(5) getSubmitTimeメソッド

説明
ジョブが登録された日時を取得します。
形式

public java.lang.String getSubmitTime()

引数
なし
戻り値
ジョブが登録された日時を,「YYYY/MM/DD.hh:mm:ss」形式で返却します。「YYYY/MM/DD.hh:mm:ss」は,「西暦年/月/日.時:分:秒」を意味します。
例外
なし

(6) getStartTimeメソッド

説明
ジョブ実行開始日時を取得します。
形式

public java.lang.String getStartTime()

引数
なし
戻り値
ジョブが実行された日時を,「YYYY/MM/DD.hh:mm:ss」形式で返却します。「YYYY/MM/DD.hh:mm:ss」は,「西暦年/月/日.時:分:秒」を意味します。
ジョブが実行されていない場合,nullを返却します。
例外
なし

(7) getEndTimeメソッド

説明
ジョブ実行終了日時を取得します。
形式

public java.lang.String getEndTime()

引数
なし
戻り値
ジョブ実行が終了した日時を,「YYYY/MM/DD.hh:mm:ss」形式で返却します。「YYYY/MM/DD.hh:mm:ss」は,「西暦年/月/日.時:分:秒」を意味します。
ジョブ実行が終了していない場合,nullを返却します。
例外
なし

(8) getJobNameメソッド

説明
ジョブ名称を取得します。
形式

public java.lang.String getJobName()

引数
なし
戻り値
ジョブ名称を,1~63バイトの文字列で返却します。
例外
なし