JobSchedulerContextオブジェクト

コンポーネント情報
version	8.0

コンポーネント概要

ジョブスケジューラコンテキストオブジェクト。

ジョブスケジューラに関する情報を格納するアクセスコンテキストです。
ジョブスケジューラにより起動したジョブ実行時に利用可能です。
コンテキストには、実行されたジョブネット関する情報と実行中のジョブネットのモニタとタスクを取得するためのID、
ジョブネット内で共有される実行に追加パラメータ等、ジョブネットの実行に関する全ての情報が格納されています。

以下のコードにより取得できます。

 var jobSchedulerContext = Contexts.getJobSchedulerContext();

オブジェクトの構造

var jobSchedulerContext = {
    fireDate : Date, // 実行日時。
    jobDetail : JobDetail, // ジョブ情報オブジェクト。
    jobnet : Jobnet, // ジョブネット情報オブジェクト。
    mergedParameters : Object, // 各オブジェクトに設定されたパラメータをマージしたパラメータ。
    monitorId : String, // モニタID。
    nextFireDate : Date, // 次回実行日時。
    parameters : Object, // 実行パラメータ。 ジョブの実行中にパラメータに追加されたパラメータを取得します。
    previousFireDate : Date, // 前回実行日時。
    taskId : String, // タスクID。
    trigger : Trigger // トリガ情報オブジェクト。
}

var jobSchedulerContext = {
    fireDate : Date, // 実行日時。
    jobDetail : JobDetail, // ジョブ情報オブジェクト。
    jobnet : Jobnet, // ジョブネット情報オブジェクト。
    mergedParameters : Object, // 各オブジェクトに設定されたパラメータをマージしたパラメータ。
    monitorId : String, // モニタID。
    nextFireDate : Date, // 次回実行日時。
    parameters : Object, // 実行パラメータ。 ジョブの実行中にパラメータに追加されたパラメータを取得します。
    previousFireDate : Date, // 前回実行日時。
    taskId : String, // タスクID。
    trigger : Trigger // トリガ情報オブジェクト。
}

プロパティの概要

型	プロパティ名	アクセス権
Date	fireDate 実行日時。	通常
JobDetail	jobDetail ジョブ情報オブジェクト。	通常
Jobnet	jobnet ジョブネット情報オブジェクト。	通常
Object	mergedParameters 各オブジェクトに設定されたパラメータをマージしたパラメータ。	通常
String	monitorId モニタID。	通常
Date	nextFireDate 次回実行日時。	通常
Object	parameters 実行パラメータ。ジョブの実行中にパラメータに追加されたパラメータを取得します。	通常
Date	previousFireDate 前回実行日時。	通常
String	taskId タスクID。	通常
Trigger	trigger トリガ情報オブジェクト。	通常

メソッドの概要

返却値の型	メソッド名
Object	getMergedParameters () 各パラメータから優先度に準じてマージされたパラメータを取得します。
String	getParameter (String `key`) 指定されたキーのパラメータを優先度に準じて取得します。
void	putParameter (String `key`, String `value`) 実行中パラメータへ指定されたパラメータを追加します。
void	putParameters (Object `parameters`) 実行中パラメータへ指定された全てのパラメータを追加します。

プロパティの詳細

Date fireDate 通常

実行日時。

JobDetail jobDetail 通常

ジョブ情報オブジェクト。

Jobnet jobnet 通常

ジョブネット情報オブジェクト。

Object mergedParameters 通常

各オブジェクトに設定されたパラメータをマージしたパラメータ。このパラメータはジョブ、ジョブネット、トリガ、実行中に追加されたパラメータの順に上書きされたパラメータを返却します。

String monitorId 通常

モニタID。

Date nextFireDate 通常

次回実行日時。

Object parameters 通常

実行パラメータ。ジョブの実行中にパラメータに追加されたパラメータを取得します。
ジョブ・ジョブネット・トリガに設定されているパラメータは含まれません。

Date previousFireDate 通常

前回実行日時。

String taskId 通常

タスクID。

Trigger trigger 通常

トリガ情報オブジェクト。

メソッドの詳細

Object getMergedParameters ()

各パラメータから優先度に準じてマージされたパラメータを取得します。

ジョブ、ジョブネット、トリガ、実行中に追加されたパラメータの順に上書きされたパラメータを返却します。

返却値

Object: Object 各オブジェクトに設定されたパラメータをマージしたパラメータ

String getParameter (String key)

指定されたキーのパラメータを優先度に準じて取得します。

実行中に追加されたパラメータ、トリガ、ジョブネット、ジョブの順に指定されたキーのパラメータが存在した時点でその値を返却します。
JobSchedulerContext#getMergedParameters()で取得したパラメータから取り出すのと同様です。

例えば、ジョブとジョブネットに同一キーのパラメータが設定されていた場合は、ジョブネットに設定されているパラメータの値が返却されます。
その場合は、以下のようこのにコンテキストからジョブのパラメータを直接取得する事で優先度に関係なくジョブに設定されているパラメータ値を取得する事も可能です。

 // ジョブスケジューラコンテキストから優先度に準じたパラメータを取得する。
 var value1 = context.getParameter("KEY");
 
 // ジョブスケジューラコンテキストからジョブの設定パラメータを取得する。
 var value2 = context.jobDetail.parameters.KEY;

パラメータ

key : String: パラメータキー

返却値

String: String パラメータキーに関連付けられている値

void putParameter (String key, String value)

実行中パラメータへ指定されたパラメータを追加します。

このメソッドで追加されたパラメータはJobSchedulerContext#getParameter(String)で優先的に返却されます。

パラメータ

key : String: パラメータキー

value : String: パラメータ値

返却値

void

void putParameters (Object parameters)

実行中パラメータへ指定された全てのパラメータを追加します。

このメソッドで追加されたパラメータはJobSchedulerContext#getParameter(String)で優先的に返却されます。
パラメータのキーと値は文字列で指定してください。

 var parameter = {
   パラメータキー : パラメータ値
 }

パラメータ

parameters : Object: パラメータ

返却値

void