Namespace: Consultingwerk.SmartFramework.Scheduler
Interface 
ISchedulerService Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.SmartFramework.Scheduler.SchedulerService

File:ISchedulerService
Purpose:Interface for der Scheduler Service
Description:This Interfaces exposes the scheduler control to an
application developer
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Jul 12 15:21:03 CEST 2016

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ DATETIME-TZ GetNextExecutionTime (character, datetime-tz) Determines the next planned execution time for the given job plan
+ DATETIME-TZ GetNextExecutionTime (datetime-tz, SchedulerJobPlanningTypeEnum, integer, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, character, character, datetime-tz, datetime-tz) Determines the next planned execution time for the given job plan
+ 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 DATETIME-TZ GetNextExecutionTime (character, datetime-tz)
Purpose: Determines the next planned execution time for the
given job plan
Notes: Only supported for recurring job plans

Parameters:
pcSchedulerJobPlanGuid CHARACTER
The job plan to return the next execution time for
pdtPreviousExecution DATETIME-TZ
The date-time-tz value identifying when the job was previously executed - or ? when the Job has neven been executed so far
Returns DATETIME-TZ
The date and time when the job plan is due for the next execution
Top

PUBLIC DATETIME-TZ GetNextExecutionTime (datetime-tz, SchedulerJobPlanningTypeEnum, integer, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, logical, character, character, datetime-tz, datetime-tz)
Purpose: Determines the next planned execution time for the
given job plan
Notes: Only supported for recurring job plans. This method performs
the actual work. It is not accessing the Business Entity to
retrieve the Job Plan parameters. This allows to call into this
method from within the Job Plan Business Entity

Parameters:
pdtPreviousExecution DATETIME-TZ
The date-time-tz value identifying when the job was previously executed - or ? when the Job has neven been executed so far
poPlanningType Consultingwerk.SmartFramework.Scheduler.SchedulerJobPlanningTypeEnum
The SchedulerJobPlanningTypeEnum value
piWeekInterval INTEGER
The week interval
plRecurringMonday LOGICAL
Plan includes Monday
plRecurringTuesday LOGICAL
Plan includes Tuesday
plRecurringWednesday LOGICAL
Plan includes Wednesday
plRecurringThursday LOGICAL
Plan includes Thursday
plRecurringFriday LOGICAL
Plan includes Friday
plRecurringSaturday LOGICAL
Plan includes Saturday
plRecurringSunday LOGICAL
Plan includes Sunday
plRecurringJanuary LOGICAL
The plan includes January
plRecurringFebruary LOGICAL
The plan includes February
plRecurringMarch LOGICAL
The plan includes March
plRecurringApril LOGICAL
The plan includes April
plRecurringMay LOGICAL
The plan includes May
plRecurringJune LOGICAL
The plan includes June
plRecurringJuly LOGICAL
The plan includes July
plRecurringAugust LOGICAL
The plan includes August
plRecurringSeptember LOGICAL
The plan includes September
plRecurringOctober LOGICAL
The plan includes October
plRecurringNovember LOGICAL
The plan includes November
plRecurringDecember LOGICAL
The plan includes December
pcRecurringDaylist CHARACTER
The list of days of month (relative to 1st or last day)
pcRecurringExecutionTimes CHARACTER
The list of planning times
pdtValidFrom DATETIME-TZ
The valid from date of the job plan
pdtValidTo DATETIME-TZ
The valid to date of the job plan
Returns DATETIME-TZ
The date and time when the job plan is due for the next execution * @return The date and time when the job plan is due for the next execution
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-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:26:38