Namespace: Consultingwerk.SmartFramework.Scheduler.Runtime
Class 
SchedulerRuntime Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Scheduler.Runtime.SchedulerRuntime

Inherits: Progress.Lang.Object

File:SchedulerRuntime
Purpose:Core scheduler runtime
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jul 17 09:55:38 CEST 2016

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ Execute () Performs execution of scheduler jobs
+ ExecuteSchedulerJob (SchedulerJobDatasetModel, SchedulerJobStatusDatasetModel) Executes a single SchedulerJob instance
# InvokeSchedulerJobCommand (ISchedulerJobCommand, Object) Calls the Start method of the
+ LOGICAL IsCancelled () Tests if the current Job is cancelled
+ UpdateJobStatus (character) Updates the Job's status
+ UpdateJobStatus (character, integer) Updates the Job's status
+ UpdateJobStatus (integer) Updates the Job's status

Top Constructor Summary
Options Name Purpose
# SchedulerRuntime () Protected default constructor of the SchedulerRuntime class

Top Property Summary
Options Name Purpose
+ LOGICAL Active Returns if the scheduler is executing a job
+ INTEGER KeepRunning Gets and sets the number of seconds (e.g. 300 = 5 minutes) the scheduler runtime job should keep running
+ INTEGER PauseBetweenPolling Gets and sets the number of seconds to wait between two polling attempts for new jobs when no job had been found previously
+ CHARACTER SchedulerJobStatusGuid Returns the currently executed SchedulerJobStatusGuid
+ LOGICAL Verbose Gets and sets if verbose output of logging messages is requested


Method Detail
Top

PUBLIC Execute ()
Purpose: Performs execution of scheduler jobs
Notes:

Top

PUBLIC ExecuteSchedulerJob (SchedulerJobDatasetModel, SchedulerJobStatusDatasetModel)
Purpose: Executes a single SchedulerJob instance
Notes:

Parameters:
poJob Consultingwerk.SmartFramework.Scheduler.SchedulerJobDatasetModel
The SchedulerJobDatasetModel with the job to execute
poJobStatus Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusDatasetModel
The SchedulerJobStatusDatasetModel with the job instance to execute
Top

PROTECTED InvokeSchedulerJobCommand (ISchedulerJobCommand, Object)
Purpose: Calls the Start method of the
Notes: Moved outside of ExecuteSchedulerJob for ability to handle
STOP conditions

Parameters:
poJobCommand Consultingwerk.SmartFramework.Scheduler.ISchedulerJobCommand
The ISchedulerJobCommand instance to execute
poParameter Progress.Lang.Object
The parameter object for the job instance
Top

PUBLIC LOGICAL IsCancelled ()
Purpose: Tests if the current Job is cancelled
Notes: When the Job was cancelled, the SmartSchedulerJobStatus record
will be set to the Cancelled status immediately. The calling
routine is expected to leave promptly

Returns LOGICAL
Logical value indicating if the Job was cancelled
Top

PUBLIC UpdateJobStatus (character)
Purpose: Updates the Job's status
Notes:

Parameters:
pcStatusText CHARACTER
The status text
Top

PUBLIC UpdateJobStatus (character, integer)
Purpose: Updates the Job's status
Notes:

Parameters:
pcStatusText CHARACTER
The status text
piPercentFinished INTEGER
The percentage to indicate the job completion
Top

PUBLIC UpdateJobStatus (integer)
Purpose: Updates the Job's status
Notes:

Parameters:
piPercentFinished INTEGER
The percentage to indicate the job completion


Constructor Detail
Top

PROTECTED SchedulerRuntime ()
Purpose: Protected default constructor of the SchedulerRuntime class
Notes: Disallow instance creation



Property Detail
Top

PUBLIC LOGICAL Active
Purpose: Returns if the scheduler is executing a job
Notes:

Returns LOGICAL
Top

PUBLIC INTEGER KeepRunning
Purpose: Gets and sets the number of seconds (e.g. 300 = 5 minutes) the
scheduler runtime job should keep running
Notes: The currently executed job will not be stopped when the runtime
limit is reached

Returns INTEGER
Top

PUBLIC INTEGER PauseBetweenPolling
Purpose: Gets and sets the number of seconds to wait between two polling
attempts for new jobs when no job had been found previously
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER SchedulerJobStatusGuid
Purpose: Returns the currently executed SchedulerJobStatusGuid
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL Verbose
Purpose: Gets and sets if verbose output of logging messages is requested
Notes: "verbose" parameter of the PCTRun task

Returns LOGICAL


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