 | IJobManagerService Interface |
Job Management Service
Namespace: SanteDB.Core.Jobs
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 2.2.1
SyntaxThe IJobManagerService type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | IsRunning |
Indicates whether the daemon service is running
(Inherited from IDaemonService.) |
| Jobs |
Gets the status of all jobs
|
| ServiceName |
Gets the service name
(Inherited from IServiceImplementation.) |
Methods| Name | Description | |
|---|---|---|
  | AddJob(IJob, JobStartType) |
Add a job to the execution manager
|
| AddJob(IJob, TimeSpan, JobStartType) | Obsolete.
Add a job to the job manager
|
| GetJobInstance |
Get this manager's instance of a job
|
| GetJobSchedules |
Get the schedule for the specified job
|
| IsJobRegistered |
Returns true if the job is registered
|
| SetJobSchedule(IJob, TimeSpan) |
Schedule a job to repeat on an interval
|
| SetJobSchedule(IJob, DayOfWeek, DateTime) |
Schedule a job to start at a specific time with a specific repetition
|
| Start |
Indicates the caller wishes to start the daemon service lifecycle
(Inherited from IDaemonService.) |
| StartJob(IJob, Object) |
Starts the specified job |
| StartJob(Type, Object) |
Start a job by registered type
|
| Stop |
Indicates the caller wishes to stop the daemon service
(Inherited from IDaemonService.) |
Events| Name | Description | |
|---|---|---|
 | Started |
Fired when the daemon service has completed it start procedure.
(Inherited from IDaemonService.) |
| Starting |
Fired when the daemon service has commenced start but has not yet finished
(Inherited from IDaemonService.) |
| Stopped |
Fired when the daemon has completed its stop procedure
(Inherited from IDaemonService.) |
| Stopping |
Fired when the daemon service has commenced stop but has not yet been fully shut down.
(Inherited from IDaemonService.) |
RemarksIn SanteDB, developers can create IJob implementations which represent background jobs for the system. Uses of these classes involve:
- Performing routine maintenance tasks like compression, backup, etc.
- Performing indexing tasks or managing long-running tasks
- Exposing packaged batch operations to users (who can run them manually from the UI)
The job manager is the service which manages the master list of IJob instances and allows other plugins to register new jobs, start jobs, and even schedule job execution based on a schedule or interval.
See Also