IScheduler Interface

public interface IScheduler

The IScheduler type exposes the following members.

	Name	Description
	Context	Returns the SchedulerContext of the IScheduler.
	InStandbyMode	Reports whether the IScheduler is in stand-by mode.
	IsShutdown	Reports whether the IScheduler has been Shutdown.
	IsStarted	Whether the scheduler has been started.
	JobFactory	Set the JobFactory that will be responsible for producing instances of IJob classes.
	ListenerManager	Get a reference to the scheduler's IListenerManager, through which listeners may be registered.
	SchedulerInstanceId	Returns the instance Id of the IScheduler.
	SchedulerName	Returns the name of the IScheduler.

	Name	Description
	AddCalendar	Add (register) the given ICalendar to the Scheduler.
	AddJob(IJobDetail, Boolean, CancellationToken)	Add the given IJob to the Scheduler - with no associated ITrigger. The IJob will be 'dormant' until it is scheduled with a ITrigger, or TriggerJob(JobKey, CancellationToken) is called for it.
	AddJob(IJobDetail, Boolean, Boolean, CancellationToken)	Add the given IJob to the Scheduler - with no associated ITrigger. The IJob will be 'dormant' until it is scheduled with a ITrigger, or TriggerJob(JobKey, CancellationToken) is called for it.
	CheckExists(JobKey, CancellationToken)	Determine whether a IJob with the given identifier already exists within the scheduler.
	CheckExists(TriggerKey, CancellationToken)	Determine whether a ITrigger with the given identifier already exists within the scheduler.
	Clear	Clears (deletes!) all scheduling data - all IJobs, ITriggers ICalendars.
	DeleteCalendar	Delete the identified ICalendar from the Scheduler.
	DeleteJob	Delete the identified IJob from the Scheduler - and any associated ITriggers.
	DeleteJobs	Delete the identified jobs from the Scheduler - and any associated ITriggers.
	GetCalendar	Get the ICalendar instance with the given name.
	GetCalendarNames	Get the names of all registered ICalendar.
	GetCurrentlyExecutingJobs	Return a list of IJobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance.
	GetJobDetail	Get the IJobDetail for the IJob instance with the given key .
	GetJobGroupNames	Get the names of all known IJobDetail groups.
	GetJobKeys	Get the keys of all the IJobDetails in the matching groups.
	GetMetaData	Get a SchedulerMetaData object describing the settings and capabilities of the scheduler instance.
	GetPausedTriggerGroups	Get the names of all ITrigger groups that are paused.
	GetTrigger	Get the ITrigger instance with the given key.
	GetTriggerGroupNames	Get the names of all known ITrigger groups.
	GetTriggerKeys	Get the names of all the ITriggers in the given groups.
	GetTriggersOfJob	Get all ITrigger s that are associated with the identified IJobDetail.
	GetTriggerState	Get the current state of the identified ITrigger.
	Interrupt(String, CancellationToken)	Request the cancellation, within this Scheduler instance, of the identified executing job instance.
	Interrupt(JobKey, CancellationToken)	Request the cancellation, within this Scheduler instance, of all currently executing instances of the identified IJob.
	IsJobGroupPaused	returns true if the given JobGroup is paused
	IsTriggerGroupPaused	returns true if the given TriggerGroup is paused
	PauseAll	Pause all triggers - similar to calling PauseTriggers(GroupMatcherTriggerKey, CancellationToken) on every group, however, after using this method ResumeAll(CancellationToken) must be called to clear the scheduler's state of 'remembering' that all new triggers will be paused as they are added.
	PauseJob	Pause the IJobDetail with the given key - by pausing all of its current ITriggers.
	PauseJobs	Pause all of the IJobDetails in the matching groups - by pausing all of their ITriggers.
	PauseTrigger	Pause the ITrigger with the given key.
	PauseTriggers	Pause all of the ITriggers in the groups matching.
	RescheduleJob	Remove (delete) the ITrigger with the given key, and store the new given one - which must be associated with the same job (the new trigger must have the job name & group specified) - however, the new trigger need not have the same name as the old trigger.
	ResumeAll	Resume (un-pause) all triggers - similar to calling ResumeTriggers(GroupMatcherTriggerKey, CancellationToken) on every group.
	ResumeJob	Resume (un-pause) the IJobDetail with the given key.
	ResumeJobs	Resume (un-pause) all of the IJobDetails in matching groups.
	ResumeTrigger	Resume (un-pause) the ITrigger with the given key.
	ResumeTriggers	Resume (un-pause) all of the ITriggers in matching groups.
	ScheduleJob(ITrigger, CancellationToken)	Schedule the given ITrigger with the IJob identified by the ITrigger's settings.
	ScheduleJob(IJobDetail, ITrigger, CancellationToken)	Add the given IJobDetail to the Scheduler, and associate the given ITrigger with it.
	ScheduleJob(IJobDetail, IReadOnlyCollectionITrigger, Boolean, CancellationToken)	Schedule the given job with the related set of triggers.
	ScheduleJobs	Schedule all of the given jobs with the related set of triggers.
	Shutdown(CancellationToken)	Halts the IScheduler's firing of ITriggers, and cleans up all resources associated with the Scheduler. Equivalent to Shutdown(false).
	Shutdown(Boolean, CancellationToken)	Halts the IScheduler's firing of ITriggers, and cleans up all resources associated with the Scheduler.
	Standby	Temporarily halts the IScheduler's firing of ITriggers.
	Start	Starts the IScheduler's threads that fire ITriggers. When a scheduler is first created it is in "stand-by" mode, and will not fire triggers. The scheduler can also be put into stand-by mode by calling the Standby(CancellationToken) method.
	StartDelayed	Calls Start(CancellationToken) after the indicated delay. (This call does not block). This can be useful within applications that have initializers that create the scheduler immediately, before the resources needed by the executing jobs have been fully initialized.
	TriggerJob(JobKey, CancellationToken)	Trigger the identified IJobDetail (Execute it now).
	TriggerJob(JobKey, JobDataMap, CancellationToken)	Trigger the identified IJobDetail (Execute it now).
	UnscheduleJob	Remove the indicated ITrigger from the scheduler. If the related job does not have any other triggers, and the job is not durable, then the job will also be deleted.
	UnscheduleJobs	Remove all of the indicated ITriggers from the scheduler.

A IScheduler maintains a registry of IJobDetails and ITriggers. Once registered, the IScheduler is responsible for executing IJob s when their associated ITrigger s fire (when their scheduled time arrives).

IScheduler instances are produced by a ISchedulerFactory. A scheduler that has already been created/initialized can be found and used through the same factory that produced it. After a IScheduler has been created, it is in "stand-by" mode, and must have its Start(CancellationToken) method called before it will fire any IJobs.

IJob s are to be created by the 'client program', by defining a class that implements the IJob interface. IJobDetail objects are then created (also by the client) to define a individual instances of the IJob. IJobDetail instances can then be registered with the IScheduler via the %IScheduler.ScheduleJob(JobDetail, Trigger)% or %IScheduler.AddJob(JobDetail, bool)% method.

ITrigger s can then be defined to fire individual IJob instances based on given schedules. ISimpleTrigger s are most useful for one-time firings, or firing at an exact moment in time, with N repeats with a given delay between them. ICronTrigger s allow scheduling based on time of day, day of week, day of month, and month of year.

IJob s and ITrigger s have a name and group associated with them, which should uniquely identify them within a single IScheduler. The 'group' feature may be useful for creating logical groupings or categorizations of IJobs and ITriggers. If you don't have need for assigning a group to a given IJobs of ITriggers, then you can use the DefaultGroup constant defined on this interface.

Stored IJob s can also be 'manually' triggered through the use of the %IScheduler.TriggerJob(string, string)% function.

Client programs may also be interested in the 'listener' interfaces that are available from Quartz. The IJobListener interface provides notifications of IJob executions. The ITriggerListener interface provides notifications of ITrigger firings. The ISchedulerListener interface provides notifications of IScheduler events and errors. Listeners can be associated with local schedulers through the IListenerManager interface.

The setup/configuration of a IScheduler instance is very customizable. Please consult the documentation distributed with Quartz.

Reference