Namespace: Consultingwerk.SmartFramework.Scheduler
Class 
SchedulerService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartFramework.Scheduler.ISchedulerService

File:SchedulerService
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jul 2 13:45:53 CEST 2016



Top Method Summary
Options Name Purpose
+ Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, character, datetime-tz, ISerializable) Schedules a Job for scheduled one time execution
+ Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, character, ISerializable) Schedules a Job for direct one time execution
+ Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, datetime-tz, ISerializable) Schedules a Job for scheduled one time execution
+ Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, ISerializable) Schedules a Job for direct one time execution
+ SetJobStatusCancelSignal (character) Sets the signal to cancel a JobStatus
+ SetJobStatusOnHold (character) Sets a JobStatus OnHold. A job on hold can be later restarted
+ SetJobStatusResumed (character) Resumes a JobStatus that is on hold or to be cancelled


Method Detail
Top

PUBLIC Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, character, datetime-tz, ISerializable)

Purpose: Schedules a Job for scheduled one time execution
Notes: Only creates an entry in the SmartSchedulerJobStatus table. An entry
in the SmartSchedulerJobPlan DB table is not required for one time
execution jobs

Parameters:
pcSchedulerJobName CHARACTER
The name of the scheduler job to execute
pcJobName CHARACTER
The name for the SchedulerJobStatus entry
pdtScheduleDateTime DATETIME-TZ
The date/time when the job schould be executed
poJobParameter Consultingwerk.ISerializable
The serializable Job Parameter instance
Returns Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse
The IScheduleJobResponse describing the identifiers of the planned job
Top

PUBLIC Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, character, ISerializable)

Purpose: Schedules a Job for direct one time execution
Notes: Only creates an entry in the SmartSchedulerJobStatus table. An entry
in the SmartSchedulerJobPlan DB table is not required for one time
execution jobs

Parameters:
pcSchedulerJobName CHARACTER
The name of the scheduler job to execute
pcJobName CHARACTER
The name for the SchedulerJobStatus entry
poJobParameter Consultingwerk.ISerializable
The serializable Job Parameter instance
Returns Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse
The IScheduleJobResponse describing the identifiers of the planned job
Top

PUBLIC Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, datetime-tz, ISerializable)

Purpose: Schedules a Job for scheduled one time execution
Notes: Only creates an entry in the SmartSchedulerJobStatus table. An entry
in the SmartSchedulerJobPlan DB table is not required for one time
execution jobs

Parameters:
pcSchedulerJobName CHARACTER
The name of the scheduler job to execute
pdtScheduleDateTime DATETIME-TZ
The date/time when the job schould be executed
poJobParameter Consultingwerk.ISerializable
The serializable Job Parameter instance
Returns Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse
The IScheduleJobResponse describing the identifiers of the planned job
Top

PUBLIC Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse ScheduleJob (character, ISerializable)

Purpose: Schedules a Job for direct one time execution
Notes: Only creates an entry in the SmartSchedulerJobStatus table. An entry
in the SmartSchedulerJobPlan DB table is not required for one time
execution jobs

Parameters:
pcSchedulerJobName CHARACTER
The name of the scheduler job to execute
poJobParameter Consultingwerk.ISerializable
The serializable Job Parameter instance
Returns Consultingwerk.SmartFramework.Scheduler.IScheduleJobResponse
The IScheduleJobResponse describing the identifiers of the planned job
Top

PUBLIC SetJobStatusCancelSignal (character)

Purpose: Sets the signal to cancel a JobStatus
Notes: Requires the JobStatus of Runnig

Parameters:
pcSchedulerJobStatusGuid CHARACTER
The GUID of the SchedulerJobStatus to put on hold
Top

PUBLIC SetJobStatusOnHold (character)

Purpose: Sets a JobStatus OnHold. A job on hold can be later restarted
Notes: Requires the JobStatus of Scheduled

Parameters:
pcSchedulerJobStatusGuid CHARACTER
The GUID of the SchedulerJobStatus to put on hold
Top

PUBLIC SetJobStatusResumed (character)

Purpose: Resumes a JobStatus that is on hold or to be cancelled
Notes: Requires the JobStatus of OnHold or to be cancelled (Running and Cancel = TRUE)

Parameters:
pcSchedulerJobStatusGuid CHARACTER
The GUID of the SchedulerJobStatus to put on hold


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:40:51