ICancellableJobExecutionContext Interface

Quartz.NET 3.0 API Documentation
Represents a job execution context which can be cancelled.

Namespace:  Quartz
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
public interface ICancellableJobExecutionContext : IJobExecutionContext

The ICancellableJobExecutionContext type exposes the following members.

Properties

  NameDescription
Public propertyCalendar
Get a handle to the ICalendar referenced by the ITrigger instance that fired the IJob.
(Inherited from IJobExecutionContext.)
Public propertyCancellationToken
Returns the cancellation token which will be cancelled when the job cancellation has been requested via Interrupt(JobKey, CancellationToken) or Interrupt(String, CancellationToken).
(Inherited from IJobExecutionContext.)
Public propertyFireInstanceId
Get the unique Id that identifies this particular firing instance of the trigger that triggered this job execution. It is unique to this JobExecutionContext instance as well.
(Inherited from IJobExecutionContext.)
Public propertyFireTimeUtc
The actual time the trigger fired. For instance the scheduled time may have been 10:00:00 but the actual fire time may have been 10:00:03 if the scheduler was too busy.
(Inherited from IJobExecutionContext.)
Public propertyJobDetail
Get the JobDetail associated with the IJob.
(Inherited from IJobExecutionContext.)
Public propertyJobInstance
Get the instance of the IJob that was created for this execution.

Note: The Job instance is not available through remote scheduler interfaces.

(Inherited from IJobExecutionContext.)
Public propertyJobRunTime
The amount of time the job ran for. The returned value will be MinValue until the job has actually completed (or thrown an exception), and is therefore generally only useful to IJobListeners and ITriggerListeners.
(Inherited from IJobExecutionContext.)
Public propertyMergedJobDataMap
Get the convenience JobDataMap of this execution context.
(Inherited from IJobExecutionContext.)
Public propertyNextFireTimeUtc
Gets the next fire time.
(Inherited from IJobExecutionContext.)
Public propertyPreviousFireTimeUtc
Gets the previous fire time.
(Inherited from IJobExecutionContext.)
Public propertyRecovering
If the IJob is being re-executed because of a 'recovery' situation, this method will return .
(Inherited from IJobExecutionContext.)
Public propertyRecoveringTriggerKey
Returns the TriggerKey of the originally scheduled and now recovering job.
(Inherited from IJobExecutionContext.)
Public propertyRefireCount
Gets the refire count.
(Inherited from IJobExecutionContext.)
Public propertyResult
Returns the result (if any) that the IJob set before its execution completed (the type of object set as the result is entirely up to the particular job).
(Inherited from IJobExecutionContext.)
Public propertyScheduledFireTimeUtc
The scheduled time the trigger fired for. For instance the scheduled time may have been 10:00:00 but the actual fire time may have been 10:00:03 if the scheduler was too busy.
(Inherited from IJobExecutionContext.)
Public propertyScheduler
Get a handle to the IScheduler instance that fired the IJob.
(Inherited from IJobExecutionContext.)
Public propertyTrigger
Get a handle to the ITrigger instance that fired the IJob.
(Inherited from IJobExecutionContext.)
Top
Methods

  NameDescription
Public methodCancel
Cancels the execution of the job. It is the responsibility of the job instance to observe the cancellation token if it can be cancelled.
Public methodGet
Get the value with the given key from the context's data map.
(Inherited from IJobExecutionContext.)
Public methodPut
Put the specified value into the context's data map with the given key. Possibly useful for sharing data between listeners and jobs.

NOTE: this data is volatile - it is lost after the job execution completes, and all TriggerListeners and JobListeners have been notified.

(Inherited from IJobExecutionContext.)
Top
See Also

Reference