IScheduler Members

Quartz.NET API Documentation

The IScheduler type exposes the following members.

Methods

	Name	Description
	AddCalendar	Add (register) the given ICalendar to the Scheduler.
	AddGlobalJobListener	Add the given IJobListener to the IScheduler's global list.
	AddGlobalTriggerListener	Add the given ITriggerListener to the IScheduler's global list.
	AddJob	Add the given IJob to the Scheduler - with no associated Trigger. The IJob will be 'dormant' until it is scheduled with a Trigger, or TriggerJob(String, String) is called for it.
	AddJobListener	Add the given IJobListener to the IScheduler's list, of registered IJobListeners.
	AddSchedulerListener	Register the given ISchedulerListener with the
	AddTriggerListener	Add the given ITriggerListener to the IScheduler's list, of registered ITriggerListeners.
	DeleteCalendar	Delete the identified ICalendar from the Scheduler.
	DeleteJob	Delete the identified IJob from the Scheduler - and any associated Triggers.
	GetCalendar	Get the ICalendar instance with the given name.
	GetCalendarNames	Get the names of all registered ICalendar.
	GetCurrentlyExecutingJobs	Return a list of JobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance.
	GetGlobalJobListener	Get the globalIJobListener that has the given name.
	GetGlobalTriggerListener	Get the globalITriggerListener that has the given name.
	GetJobDetail	Get the JobDetail for the IJob instance with the given name and group.
	GetJobListener	Get the non-globalIJobListener that has the given name.
	GetJobNames	Get the names of all the JobDetails in the given group.
	GetMetaData	Get a SchedulerMetaData object describiing the settings and capabilities of the scheduler instance.
	GetPausedTriggerGroups	Get the names of all Trigger groups that are paused.
	GetTrigger	Get the Trigger instance with the given name and group.
	GetTriggerListener	Get the non-globalITriggerListener that has the given name.
	GetTriggerNames	Get the names of all the Triggers in the given group.
	GetTriggersOfJob	Get all Trigger s that are associated with the identified JobDetail.
	GetTriggerState	Get the current state of the identified Trigger.
	Interrupt	Request the interruption, within this Scheduler instance, of all currently executing instances of the identified IJob, which must be an implementor of the IInterruptableJob interface.
	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 PauseTriggerGroup(String) on every group, however, after using this method ResumeAll 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 JobDetail with the given name - by pausing all of its current Triggers.
	PauseJobGroup	Pause all of the JobDetails in the given group - by pausing all of their Triggers.
	PauseTrigger	Pause the Trigger with the given name.
	PauseTriggerGroup	Pause all of the Triggers in the given group.
	RemoveGlobalJobListener(String)	Remove the identifed IJobListener from the IScheduler's list of global listeners.
	RemoveGlobalJobListener(IJobListener)	Remove the given IJobListener from the IScheduler's list of global listeners.
	RemoveGlobalTriggerListener(String)	Remove the identifed ITriggerListener from the IScheduler's list of global listeners.
	RemoveGlobalTriggerListener(ITriggerListener)	Remove the given ITriggerListener from the IScheduler's list of global listeners.
	RemoveJobListener	Remove the identifed IJobListener from the IScheduler's list of registered listeners.
	RemoveSchedulerListener	Remove the given ISchedulerListener from the IScheduler.
	RemoveTriggerListener	Remove the identifed ITriggerListener from the IScheduler's list of registered listeners.
	RescheduleJob	Remove (delete) the Trigger with the given name, 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 ResumeTriggerGroup(String) on every group.
	ResumeJob	Resume (un-pause) the JobDetail with the given name.
	ResumeJobGroup	Resume (un-pause) all of the JobDetails in the given group.
	ResumeTrigger	Resume (un-pause) the Trigger with the given name.
	ResumeTriggerGroup	Resume (un-pause) all of the Triggers in the given group.
	ScheduleJob(Trigger)	Schedule the given Trigger with the IJob identified by the Trigger's settings.
	ScheduleJob(JobDetail, Trigger)	Add the given JobDetail to the Scheduler, and associate the given Trigger with it.
	Shutdown	Halts the IScheduler's firing of Triggers, and cleans up all resources associated with the Scheduler. Equivalent to Shutdown(Boolean).
	Shutdown(Boolean)	Halts the IScheduler's firing of Triggers, and cleans up all resources associated with the Scheduler.
	Standby	Temporarily halts the IScheduler's firing of Triggers.
	Start	Starts the IScheduler's threads that fire Triggers. 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 method.
	StartDelayed	Calls Start 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(String, String)	Trigger the identified JobDetail (Execute it now) - the generated trigger will be non-volatile.
	TriggerJob(String, String, JobDataMap)	Trigger the identified JobDetail (Execute it now) - the generated trigger will be non-volatile.
	TriggerJobWithVolatileTrigger(String, String)	Trigger the identified JobDetail (Execute it now) - the generated trigger will be volatile.
	TriggerJobWithVolatileTrigger(String, String, JobDataMap)	Trigger the identified JobDetail (Execute it now) - the generated trigger will be volatile.
	UnscheduleJob	Remove the indicated Trigger from the scheduler.

Top

Properties

	Name	Description
	CalendarNames	Get the names of all registered ICalendars.
	Context	Returns the SchedulerContext of the IScheduler.
	GlobalJobListeners	Get a List containing all of the IJobListener s in the IScheduler'sglobal list.
	GlobalTriggerListeners	Get a List containing all of the ITriggerListener s in the IScheduler'sglobal list.
	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.
	JobGroupNames	Get the names of all known JobDetail groups.
	JobListenerNames	Get a Set containing the names of all the non-globalIJobListener s registered with the IScheduler.
	SchedulerInstanceId	Returns the instance Id of the IScheduler.
	SchedulerListeners	Get a List containing all of the ISchedulerListener s registered with the IScheduler.
	SchedulerName	Returns the name of the IScheduler.
	TriggerGroupNames	Get the names of all known Trigger groups.
	TriggerListenerNames	Get a Set containing the names of all the non-globalITriggerListener s registered with the IScheduler.

Top