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
Purpose: Raised when a job status is set to Cancelled
Notes:

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



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
# SetJobStatus (SmartSchedulerJobStatusTableModel, SchedulerJobStatusEnum) Sets the Job Status and raises the JobStatusChanged event
+ 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 Event Summary
Options Name Purpose
+ JobCancelled (JobStatusEventArgs) Raised when a job status is set to Cancelled
+ JobFailed (JobStatusEventArgs) Raised when a job status is set to Failed
+ JobFinished (JobStatusEventArgs) Raised when a job status is set to Finished
+ JobRunning (JobStatusEventArgs) Raised when a job status is set to Running
+ JobStatusChanged (JobStatusEventArgs) Raised when the job status changes

Top Property Summary
Options Name Purpose
+ LOGICAL Active
+ INTEGER KeepRunning
+ INTEGER PauseBetweenPolling
+ CHARACTER QueueCode
+ CHARACTER SchedulerJobStatusGuid
+ LOGICAL Verbose


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

PROTECTED SetJobStatus (SmartSchedulerJobStatusTableModel, SchedulerJobStatusEnum)
Purpose: Sets the Job Status and raises the JobStatusChanged event
Notes:

Parameters:
poSmartSchedulerJobStatus Consultingwerk.SmartFramework.Scheduler.SmartSchedulerJobStatusTableModel
The SmartSchedulerJobStatusTableModel representing the current job
poJobStatus Consultingwerk.SmartFramework.Scheduler.SchedulerJobStatusEnum
The status to set
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



Event Detail
Top

PUBLIC JobCancelled (JobStatusEventArgs)
Purpose: Raised when a job status is set to Cancelled
Notes:

Parameters:
e Consultingwerk.SmartFramework.Scheduler.Runtime.JobStatusEventArgs
The JobStatusEventArgs with the details of this event
Top

PUBLIC JobFailed (JobStatusEventArgs)
Purpose: Raised when a job status is set to Failed
Notes:

Parameters:
e Consultingwerk.SmartFramework.Scheduler.Runtime.JobStatusEventArgs
The JobStatusEventArgs with the details of this event
Top

PUBLIC JobFinished (JobStatusEventArgs)
Purpose: Raised when a job status is set to Finished
Notes:

Parameters:
e Consultingwerk.SmartFramework.Scheduler.Runtime.JobStatusEventArgs
The JobStatusEventArgs with the details of this event
Top

PUBLIC JobRunning (JobStatusEventArgs)
Purpose: Raised when a job status is set to Running
Notes:

Parameters:
e Consultingwerk.SmartFramework.Scheduler.Runtime.JobStatusEventArgs
The JobStatusEventArgs with the details of this event
Top

PUBLIC JobStatusChanged (JobStatusEventArgs)
Purpose: Raised when the job status changes
Notes:

Parameters:
e Consultingwerk.SmartFramework.Scheduler.Runtime.JobStatusEventArgs
The JobStatusEventArgs with the details of this event


Property Detail
Top

PUBLIC LOGICAL Active

Returns LOGICAL
Top

PUBLIC INTEGER KeepRunning

Returns INTEGER
Top

PUBLIC INTEGER PauseBetweenPolling

Returns INTEGER
Top

PUBLIC CHARACTER QueueCode

Returns CHARACTER
Top

PUBLIC CHARACTER SchedulerJobStatusGuid

Returns CHARACTER
Top

PUBLIC LOGICAL Verbose

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 13:14:35