The IScheduler type exposes the following members.
Methods
Name | Description | |
---|---|---|
AddCalendar |
Add (register) the given ICalendar to the Scheduler.
| |
AddJob(IJobDetail, Boolean) |
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)
is called for it.
| |
AddJob(IJobDetail, Boolean, Boolean) |
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)
is called for it.
| |
CheckExists(JobKey) |
Determine whether a IJob with the given identifier already
exists within the scheduler.
| |
CheckExists(TriggerKey) |
Determine whether a ITrigger with the given identifier already
exists within the scheduler.
| |
Clear | ||
DeleteCalendar |
Delete the identified ICalendar from the Scheduler.
| |
DeleteJob | ||
DeleteJobs |
Delete the identified jobs from the Scheduler - and any
associated ITriggers.
| |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
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) |
Request the interruption, within this Scheduler instance, of the
identified executing job instance, which
must be an implementor of the IInterruptableJob interface.
| |
Interrupt(JobKey) |
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 PauseTriggers(GroupMatcher TriggerKey )
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 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(GroupMatcher TriggerKey ) 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) | ||
ScheduleJob(IJobDetail, ITrigger) |
Add the given IJobDetail to the
Scheduler, and associate the given ITrigger with
it.
| |
ScheduleJob(IJobDetail, ISet ITrigger , Boolean) |
Schedule the given job with the related set of triggers.
| |
ScheduleJobs |
Schedule all of the given jobs with the related set of triggers.
| |
Shutdown |
Halts the IScheduler's firing of ITriggers,
and cleans up all resources associated with the Scheduler. Equivalent to Shutdown(false).
| |
Shutdown(Boolean) |
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 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(JobKey) |
Trigger the identified IJobDetail
(Execute it now).
| |
TriggerJob(JobKey, JobDataMap) |
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.
|
Properties
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.
|
See Also