QuartzScheduler Members

Quartz.NET API Documentation

The QuartzScheduler type exposes the following members.

Constructors

	Name	Description
	QuartzScheduler	Create a QuartzScheduler with the given configuration properties.

Top

Methods

	Name	Description
	AddCalendar	Add (register) the given ICalendar to the Scheduler.
	AddGlobalJobListener	Add the given IJobListener to the IScheduler'sglobal list. Listeners in the 'global' list receive notification of execution events for ALL IJobs.
	AddGlobalTriggerListener	Add the given ITriggerListener to the IScheduler'sglobal list. Listeners in the 'global' list receive notification of execution events for ALL Triggers.
	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. The IJob must by definition be 'durable', if it is not, SchedulerException will be thrown.
	AddJobListener	Add the given IJobListener to the IScheduler's list, of registered IJobListeners.
	AddNoGCObject	Adds an object that should be kept as reference to prevent it from being garbage collected.
	AddSchedulerListener	Register the given ISchedulerListener with the IScheduler.
	AddTriggerListener	Add the given ITriggerListener to the IScheduler's list, of registered ITriggerListeners.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	DeleteCalendar	Delete the identified ICalendar from the Scheduler.
	DeleteJob	Delete the identified IJob from the Scheduler - and any associated Triggers.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetCalendar	Get the ICalendar instance with the given name.
	GetCalendarNames	Get the names of all registered ICalendars.
	GetGlobalJobListener	Get the globalIJobListener that has the given name.
	GetGlobalTriggerListener	Get the globalITriggerListener that has the given name.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetJobDetail	Get the JobDetail for the IJob instance with the given name and group.
	GetJobGroupNames	Get the names of all known IJob groups.
	GetJobListener	Get the non-globalIJobListener that has the given name.
	GetJobNames	Get the names of all the IJobs in the given group.
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetPausedTriggerGroups	Gets the paused trigger groups.
	GetTrigger	Get the Trigger instance with the given name and group.
	GetTriggerGroupNames	Get the names of all known Trigger groups.
	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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Overrides MarshalByRefObject InitializeLifetimeService .)
	Interrupt	Interrupt all instances of the identified InterruptableJob.
	IsJobGroupPaused
	IsTriggerGroupPaused
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	NextLong	Creates a new positive random number
	NotifyJobListenersToBeExecuted	Notifies the job listeners about job to be executed.
	NotifyJobListenersWasExecuted	Notifies the job listeners that job was executed.
	NotifyJobListenersWasVetoed	Notifies the job listeners that job exucution was vetoed.
	NotifyJobStoreJobComplete	Notifies the job store job complete.
	NotifyJobStoreJobVetoed
	NotifySchedulerListenersError	Notifies the scheduler listeners about scheduler error.
	NotifySchedulerListenersFinalized	Notifies the scheduler listeners about finalized trigger.
	NotifySchedulerListenersPausedJob	Notifies the scheduler listeners about paused job.
	NotifySchedulerListenersPausedTrigger	Notifies the scheduler listeners about paused trigger.
	NotifySchedulerListenersResumedJob	Notifies the scheduler listeners about resumed job.
	NotifySchedulerListenersResumedTrigger	Notifies the scheduler listeners resumed trigger.
	NotifySchedulerListenersScheduled	Notifies the scheduler listeners about job that was scheduled.
	NotifySchedulerListenersShutdown	Notifies the scheduler listeners about scheduler shutdown.
	NotifySchedulerListenersUnscheduled	Notifies the scheduler listeners about job that was unscheduled.
	NotifySchedulerThread	Notifies the scheduler thread.
	NotifyTriggerListenersComplete	Notifies the trigger listeners of completion.
	NotifyTriggerListenersFired	Notifies the trigger listeners about fired trigger.
	NotifyTriggerListenersMisfired	Notifies the trigger listeners about misfired trigger.
	PauseAll	Pause all triggers - equivalent of calling PauseTriggerGroup(SchedulingContext, String) on every group. When ResumeAll(SchedulingContext) is called (to un-pause), trigger misfire instructions WILL be applied.
	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.
	RemoveNoGCObject	Removes the object from garbae collection protected list.
	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.
	ResumeAll	Resume (un-pause) all triggers - equivalent of calling ResumeTriggerGroup(SchedulingContext, String) on every group. If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.
	ResumeJob	Resume (un-pause) the JobDetail with the given name. If any of the IJob'sTrigger s missed one or more fire-times, then the Trigger's misfire instruction will be applied.
	ResumeJobGroup	Resume (un-pause) all of the JobDetails in the given group. If any of the IJob s had Trigger s that missed one or more fire-times, then the Trigger's misfire instruction will be applied.
	ResumeTrigger	Resume (un-pause) the Trigger with the given name. If the Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.
	ResumeTriggerGroup	Resume (un-pause) all of the Triggers in the given group. If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.
	ScheduleJob(SchedulingContext, Trigger)	Schedule the given Trigger with the IJob identified by the Trigger's settings.
	ScheduleJob(SchedulingContext, JobDetail, Trigger)	Add the IJob identified by the given JobDetail to the Scheduler, and associate the given Trigger with it. If the given Trigger does not reference any IJob, then it will be set to reference the Job passed with it into this method.
	Shutdown	Halts the QuartzScheduler's firing of Triggers, and cleans up all resources associated with the QuartzScheduler. Equivalent to Shutdown(Boolean). The scheduler cannot be re-started.
	Shutdown(Boolean)	Halts the QuartzScheduler's firing of Triggers, and cleans up all resources associated with the QuartzScheduler. The scheduler cannot be re-started.
	Standby	Temporarily halts the QuartzScheduler's firing of Triggers. The scheduler is not destroyed, and can be re-started at any time.
	Start	Starts the QuartzScheduler's threads that fire Triggers. All Triggers that have misfired will be passed to the appropriate TriggerListener(s).
	StartDelayed
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	TriggerJob	Trigger the identified IJob (Execute it now) - with a non-volatile trigger.
	TriggerJobWithVolatileTrigger	Trigger the identified IJob (Execute it now) - with a volatile trigger.
	UnscheduleJob	Remove the indicated Trigger from the scheduler.
	ValidateState	Validates the state.

Top

Properties

	Name	Description
	CurrentlyExecutingJobs	Return a list of JobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance. This method is not cluster aware. That is, it will only return Jobs currently executing in this Scheduler instance, not across the entire cluster. Note that the list returned is an 'instantaneous' snap-shot, and that as soon as it's returned, the true list of executing jobs may be different.
	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 paused.
	IsShutdown	Reports whether the IScheduler has been Shutdown.
	JobFactory	Gets or sets the job factory.
	JobListenerNames	Get a Set containing the names of all the non-globalIJobListener s registered with the IScheduler.
	JobStoreClass	Gets the job store class.
	NumJobsExecuted	Gets the number of jobs executed.
	RunningSince	Gets the running since.
	SchedulerContext	Returns the SchedulerContext of the IScheduler.
	SchedulerInstanceId	Returns the instance Id of the QuartzScheduler.
	SchedulerListeners	Get a List containing all of the ISchedulerListener s registered with the IScheduler.
	SchedulerName	Returns the name of the QuartzScheduler.
	SchedulerSignaler	Gets the scheduler signaler.
	SignalOnSchedulingChange	Gets or sets a value indicating whether to signal on scheduling change.
	SupportsPersistence	Gets a value indicating whether this scheduler supports persistence.
	ThreadPoolClass	Gets the thread pool class.
	ThreadPoolSize	Gets the size of the thread pool.
	TriggerListenerNames	Get a Set containing the names of all the non-globalITriggerListener s registered with the IScheduler.
	Version	Gets the version of the Quartz Scheduler.
	VersionIteration	Gets the version iteration.
	VersionMajor	Gets the version major.
	VersionMinor	Gets the version minor.

Top