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

Inherits: Progress.Lang.Object

File:SchedulerWeeklyPlanningHelper
Purpose:Helper for the Scheduler Service for date/time calculation
based on the weekly planning pattern
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Aug 28 15:28:45 CEST 2016
Purpose: Returns the next planning on a day in a future week. Week is
based on current week and Interval
Notes: Week start is Monday, Interval is 1 based, so 2 means every second
week

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



Top Method Summary
Options Name Purpose
+ DATETIME-TZ NextPlanningInNextWeek (datetime-tz, integer, logical, logical, logical, logical, logical, logical, logical, character) Returns the next planning on a day in a future week. Week is based on current week and Interval
+ DATETIME-TZ NextPlanningInSameWeek (datetime-tz, logical, logical, logical, logical, logical, logical, logical, character) Returns the next planning on a following day but still in the same week
+ DATETIME-TZ NextPlanningOnSameDay (datetime-tz, character) Returns the next planning on the same day

Top Constructor Summary
Options Name Purpose
# SchedulerWeeklyPlanningHelper () Protected default constructor


Method Detail
Top

PUBLIC DATETIME-TZ NextPlanningInNextWeek (datetime-tz, integer, logical, logical, logical, logical, logical, logical, logical, character)
Purpose: Returns the next planning on a day in a future week. Week is
based on current week and Interval
Notes: Week start is Monday, Interval is 1 based, so 2 means every second
week

Parameters:
pdtPreviousExecution DATETIME-TZ
The previous execution date/time
piWeekInterval INTEGER
The week interval
plPlanMonday LOGICAL
Plan includes Monday
plPlanTuesday LOGICAL
Plan includes Tuesday
plPlanWednesday LOGICAL
Plan includes Wednesday
plPlanThursday LOGICAL
Plan includes Thursday
plPlanFriday LOGICAL
Plan includes Friday
plPlanSaturday LOGICAL
Plan includes Saturday
plPlanSunday LOGICAL
Plan includes Sunday
pcTimes CHARACTER
The list of planning times
Returns DATETIME-TZ
The next planning date/time or ?
Top

PUBLIC DATETIME-TZ NextPlanningInSameWeek (datetime-tz, logical, logical, logical, logical, logical, logical, logical, character)
Purpose: Returns the next planning on a following day but still in the
same week
Notes: Week start is Monday

Parameters:
pdtPreviousExecution DATETIME-TZ
The previous execution date/time
plPlanMonday LOGICAL
Plan includes Monday
plPlanTuesday LOGICAL
Plan includes Tuesday
plPlanWednesday LOGICAL
Plan includes Wednesday
plPlanThursday LOGICAL
Plan includes Thursday
plPlanFriday LOGICAL
Plan includes Friday
plPlanSaturday LOGICAL
Plan includes Saturday
plPlanSunday LOGICAL
Plan includes Sunday
pcTimes CHARACTER
The list of planning times
Returns DATETIME-TZ
The next planning date/time or ?
Top

PUBLIC DATETIME-TZ NextPlanningOnSameDay (datetime-tz, character)
Purpose: Returns the next planning on the same day
Notes:

Parameters:
pdtPreviousExecution DATETIME-TZ
The previous execution date/time
pcTimes CHARACTER
The list of planning times
Returns DATETIME-TZ
The next planning date/time or ?


Constructor Detail
Top

PROTECTED SchedulerWeeklyPlanningHelper ()
Purpose: Protected default constructor
Notes: Disallow instance creation



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