Home > Class Reference > ENSLIB namespace > Ens.ScheduleHandler

Ens.ScheduleHandler

persistent class Ens.ScheduleHandler extends Ens.BusinessProcess

SQL Table Name: Ens.ScheduleHandler

Method Inventory

Parameters

parameter DOMAIN = Ensemble;
parameter SKIPMESSAGEHISTORY = 1;
Inherited description: If this parameter is TRUE, then arrays %MessagesSent and %MessagesReceived will not be populated.

Methods

classmethod AdjustedCurrentTime(adjustment) as %String [ Language = objectscript ]
classmethod Next(pScheduleDateTime As %String, pDirection As %String, pCurrentDateTime As %String = "") as %String [ Language = objectscript ]
method OnRequest(pRequest As %Library.Persistent, Output pResponse As %Library.Persistent) as %Status [ Language = objectscript ]
Inherited description: Handle a 'Request'
method OnResponse(request As %Library.Persistent, ByRef response As Ens.Response, callrequest As %Library.Persistent, callresponse As %Library.Persistent, pCompletionKey As %String) as %Status [ Language = objectscript ]
Inherited description: Handle a 'Response'
classmethod ParseScheduleSpec(pScheduleSpec As %String, Output pCurrentState As %String, Output pNextEventDateTime As %String, Output pNextEventAction As %String, pCurrentDateTime As %String = "") as %Status [ Language = objectscript ]
classmethod PurgeAlarmSets(Output pDeletedCount As %Integer, pDaysToKeep As %Integer = 7) as %Status [ Language = objectscript ]
This method is used to clean up the $$$EnsRuntimeAppData("SchedulerHandler","AlarmSet") data Called by Ens.MonitorService::Purge
classmethod Test(pSchedule, pCurrentTime) [ Language = objectscript ]
method UpdateProduction(pCalledFromAResponse As %Boolean = 0) as %Status [ Language = objectscript ]
classmethod adjust(dt, adjust) as %String [ Language = objectscript ]
classmethod compare(dt1, dt2) as %Integer [ Language = objectscript ]
classmethod dstCompensatedCurrentTime() as %String [ Language = objectscript ]
For the purpose of current time (actual time as opposed to formal time) this method collapses the first duplicated hour or half hour, when moving local time back (DST off), to a single point in time. For example, the first occurrence of 2009-11-01T01:00:00 to 2009-11-01T02:00:00 (i.e. when DST is on, for there is another occurrence of 2009-11-01T01:00:00 to 2009-11-01T02:00:00 with DST off after the clock change).
classmethod dstCompensatedScheduleTime(datetime) as %String [ Language = objectscript ]
For the purpose of schedule time (formal time as opposed to actual time) this method collapses the non-existing hour, when turning DST on, to a single point in time For example, 2009-03-08T02:00:00 to 2009-03-08T03:00:00
classmethod isValid(dt) as %Boolean [ Language = objectscript ]
classmethod makeValid(dt) [ Language = objectscript ]

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"pending",n)
=
%MasterPendingResponses(n)

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"received",n)
=
%MessagesReceived(n)

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID,"sent",n)
=
%MessagesSent(n)

Storage Model: Storage (Ens.BusinessProcess)

^Ens.BusinessProcessD(ID)
=
%%CLASSNAME
%ConfigQueueName
%IsCompleted
%MasterPendingResponsesOld
%PrimaryRequestHeader
%PrimaryResponseHeader
%RepliedStatus
%responseId
Adapter
%SessionId
%TimeCompleted
%TimeCreated
%ConfigName
%QuitTask
AlertOnError
%responseClassName
%IsTimerInterrupted
%IsTerminated
%StatusCode
%MessagesReceivedOld
%MessagesSentOld
ReplyCodeActions
RetryInterval
AlertRetryGracePeriod
FailureTimeout
Retry
SuspendMessage
QueueCountAlert
QueueWaitAlert
InactivityTimeout
BusinessPartner
AlertGroups
%SuperSession