インターフェース JobContext
public interface JobContext
JobContext は、現在のジョブ実行に関する情報を提供します。
方法の概要
修飾子と型メソッド説明getBatchStatus メソッドは、バッチランタイムによって設定されたバッチステータス値をジョブコンテキストに返すだけです。longgetExecutionId メソッドは、現在のジョブの現在の実行 ID を返します。getExitStatus メソッドは、setExitStatus メソッドを通じてジョブコンテキストに格納された終了ステータス値または null を返すだけです。longgetInstanceId メソッドは、現在のジョブのインスタンス ID を返します。ジョブ名を取得するgetProperties メソッドは、ジョブ定義で指定されたジョブレベルのプロパティを返します。getTransientUserData メソッドは、現在のジョブ XML 実行要素に属する一時データオブジェクトを返します。voidsetExitStatus(StringSE status) setExitStatus メソッドは、現在のジョブにユーザー指定の終了ステータスを割り当てます。voidsetTransientUserData(ObjectSE data) setTransientUserData メソッドは、一時的なデータオブジェクトを現在のバッチコンテキストに格納します。
方法の詳細
getJobName
StringSE getJobName()ジョブ名を取得する- 戻り値:
- <job> からの 'id' 属性の値
getTransientUserData
ObjectSE getTransientUserData()getTransientUserData メソッドは、現在のジョブ XML 実行要素に属する一時データオブジェクトを返します。- 戻り値:
- ユーザー指定の型
setTransientUserData
setTransientUserData メソッドは、一時的なデータオブジェクトを現在のバッチコンテキストに格納します。- パラメーター:
data- ユーザー指定の型です
getInstanceId
long getInstanceId()getInstanceId メソッドは、現在のジョブのインスタンス ID を返します。- 戻り値:
- ジョブインスタンス ID
getExecutionId
long getExecutionId()getExecutionId メソッドは、現在のジョブの現在の実行 ID を返します。- 戻り値:
- ジョブ実行 ID
getProperties
PropertiesSE getProperties()getProperties メソッドは、ジョブ定義で指定されたジョブレベルのプロパティを返します。
いくつかの注意事項:- 同じ Properties オブジェクトインスタンスが常に同じ(ジョブ)スコープで返されるという保証はありません。
- <job> 要素の子 <properties> 要素内の JSL で定義されているプロパティに加えて、バッチランタイム実装は、追加の実装定義プロパティを含めることを選択できます。
- 戻り値:
- ジョブレベルのプロパティ
getBatchStatus
BatchStatus getBatchStatus()getBatchStatus メソッドは、バッチランタイムによって設定されたバッチステータス値をジョブコンテキストに返すだけです。- 戻り値:
- バッチステータス文字列
getExitStatus
StringSE getExitStatus()getExitStatus メソッドは、setExitStatus メソッドを通じてジョブコンテキストに格納された終了ステータス値または null を返すだけです。- 戻り値:
- 終了ステータス文字列
setExitStatus
setExitStatus メソッドは、現在のジョブに対してユーザー指定の終了ステータスを割り当てます。ジョブが終了すると、ジョブの終了ステータスは setExitStatus で指定された値になります。setExitStatus が呼び出されなかったか、null 値で呼び出された場合、終了ステータスはデフォルトでジョブのバッチステータスになります。- パラメーター:
status- 終了ステータス文字列