Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / Ens.ScheduleHandler
Private  Storage   


persistent class Ens.ScheduleHandler extends


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 16


This is an Ensemble Business Process class.

%Library.Persistent %Library.Persistent

%ActionHint %Concurrency %ConfigName %ConfigQueueName
%CurrentResponseHeader %IsCompleted %IsTerminated %IsTimerInterrupted
%LastActionTime %LastHandledTime %LastReportedError %MasterPendingResponses
%MasterPendingResponsesOld %MessagesReceived %MessagesReceivedOld %MessagesSent
%MessagesSentOld %PrimaryRequestHeader %PrimaryResponseHeader %QuitTask
%RepliedStatus %SessionId %StatusCode %SuperSession
%TimeCompleted %TimeCreated %WarnedLatest %isShadow
%request %response %responseClassName %responseId
Adapter AlertGroups AlertOnError AlertRetryGracePeriod
BusinessPartner FailureTimeout InactivityTimeout QueueCountAlert
QueueWaitAlert ReplyCodeActions Retry RetryInterval
SuspendMessage ThrottleDelay

%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesSegment %BuildObjectGraph %CheckConstraints %CheckConstraintsForExtent
%ClassIsLatestVersion %ClassName %Close %ComposeOid
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DowngradeConcurrency
%ExecuteAfterTriggers %ExecuteBeforeTriggers %Exists %ExistsId
%Extends %FileIndices %FileIndicesBuffered %GUID
%GUIDSet %GetLock %GetParameter %GetSwizzleObject
%Id %IncrementCount %InsertBatch %IsA
%IsModified %IsNull %JournalObject %KillExtent
%KillExtentData %LoadFromMemory %LockExtent %LockId
%New %NormalizeObject %ObjectIsNull %ObjectModified
%Oid %OnBeforeAddToSync %OnClose %OnDetermineClass
%OnNew %Open %OpenId %OriginalNamespace
%PackageName %PhysicalAddress %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %SQLAcquireLock
%SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers %SQLBuildIndices
%SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique %SQLCheckUniqueIndices
%SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol %SQLCreateInsDelTables
%SQLDefineiDjVars %SQLDelete %SQLDeleteChildren %SQLDeleteTempStreams
%SQLEExit %SQLExists %SQLFKeyDelLock %SQLFieldValidate
%SQLGetLock %SQLGetOld %SQLGetOldAll %SQLGetOldIndex
%SQLInsert %SQLInsertComputes %SQLInsertStreams %SQLInvalid
%SQLInvalid2 %SQLMVDelete %SQLMVIndexDelete %SQLMVIndexInsert
%SQLMVIndexUpdate %SQLMVInsert %SQLMVUpdate %SQLMissing
%SQLNormalizeCompFields %SQLNormalizeFields %SQLPurgeIndices %SQLQuickBulkInsert
%SQLQuickBulkLoad %SQLQuickBulkSave %SQLQuickBulkUpdate %SQLQuickDelete
%SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey %SQLQuickInsert
%SQLQuickLoad %SQLQuickLoadChildren %SQLQuickLogicalToOdbc %SQLQuickOdbcToLogical
%SQLQuickUpdate %SQLReleaseLock %SQLReleaseTableLock %SQLStorageValidation
%SQLTrigDelTab %SQLTrigInsTab %SQLUnlock %SQLUnlock2
%SQLUnlockError %SQLUnlockRef %SQLUpdate %SQLUpdateComputes
%SQLUpdateStreams %SQLValidateCompFields %SQLValidateFields %SQLicompView
%SQLnBuild %Save %SaveDirect %SaveIndices
%SerializeObject %SetModified %SortBegin %SortEnd
%SuperSessionSet %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
%requestGet %responseGet %responseSet AdapterName
AdjustedCurrentTime AssignOneSetting ClearAllPendingResponses DeferResponse
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch EvalInitialExpression
GenerateSuperSession GetDeferredResponseToken GetMessageList GetProductionSettingValue
GetProductionSettings GetPropertyConnections GetRequestClassList GetResponseClassList
GetSettings GetShadowInstance IsResponsePending MessageHeaderHandler
Next OnComplete OnError OnErroredResponse
OnFailureTimeout OnGenerateSuperSession OnGetConnections OnGetReplyAction
OnInit OnKeepalive OnMonitor OnProductionStart
OnProductionStop OnRequest OnResponse OnTask
OnTearDown OnTimeout ParseScheduleSpec Purge
QueueName RemovePendingResponse Reply ReplyError
SendAlert SendDeferredResponse SendRequestAsync SendRequestAsyncInternal
SendRequestSync SendRequestSyncMultiple SetTimer Test
UpdateProduction ValidateScheduleSpec WillHandleErroredResponse acceptRequestAsync
acceptRequestSync adjust compare doReplyAction
dstCompensatedCurrentTime dstCompensatedScheduleTime finalReplyAction findCachedObject
getId initConfig inprocRequest isValid
makeConnections makeValid queueRequestAsync queueRequestSync
recreatePrimaryRequestHeader validateSchedulePiece


• parameter DOMAIN = "Ensemble";
If this parameter is TRUE, then arrays %MessagesSent and %MessagesReceived will not be populated.


• classmethod AdjustedCurrentTime(adjustment) as %String
• classmethod Next(pScheduleDateTime As %String, pDirection As %String, pCurrentDateTime As %String = "") as %String
• method OnRequest(pRequest As %Library.Persistent, Output pResponse As %Library.Persistent) as %Status
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
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
• classmethod Test(pSchedule, pCurrentTime)
• method UpdateProduction() as %Status
• classmethod ValidateScheduleSpec(ByRef pScheduleSpec, ByRef pScheduleErrors, Output pLength) as %Status
This method checks for the syntax validity of an entire ScheduleSpec. It returns an error if the syntax of the ScheduleSpec is invalid. It returns an array of responses that explains the problem in detail if there is any invalid syntax.
• classmethod adjust(dt, adjust) as %String
• classmethod compare(dt1, dt2) as %Integer
• classmethod dstCompensatedCurrentTime() as %String
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
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
• classmethod makeValid(dt)
• method recreatePrimaryRequestHeader(pRequestHeader As Ens.MessageHeader, Output pSC As %Status = $$$OK, Output pWarningText As %String = "") as Ens.MessageHeader
Internal method used to recreate a primary request header for the scheduler.
• classmethod validateSchedulePiece(ByRef pScheduleSpec) as %Status
This method checks for the syntax validity of one piece of a ScheduleSpec. It returns an error if the syntax of the ScheduleSpec is invalid If the syntax is valid, pScheduleSpec will contain the normalized ScheduleSpec