 | IJob |
Job Management Service
Namespace: SanteDB.Core.Jobs
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 3.0.2081-alpha+b4ae72647f2cc271f89142f76fff26ad69e00f5a
SyntaxThe IJobManagerService type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | 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) |
Add a job to the job manager
Obsolete |
| ClearJobSchedule | Clear the schedule of a job. |
| GetAvailableJobs | Get all available jobs, in the current application domain |
| GetJobInstance(Guid) | Get this manager's instance of a job |
| GetJobInstance(Type) | Get the job instance from jobType |
| GetJobSchedules | Get the schedule for the specified job |
| IsJobRegistered | Returns true if the job is registered |
| RegisterJob | Adds a job by type to the job manager |
| 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 |
| StartJob(IJob, Object) | Starts the specified job |
| StartJob(Type, Object) | Start a job by registered type |
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