Home > Class Reference > ENSLIB namespace > Ens.AlarmRequest

Ens.AlarmRequest

persistent class Ens.AlarmRequest extends Ens.Request

SQL Table Name: Ens.AlarmRequest

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization

Properties

property DiscardOnShutdown as %Boolean [ InitialExpression = 0 ];
Property methods: DiscardOnShutdownDisplayToLogical(), DiscardOnShutdownGet(), DiscardOnShutdownGetStored(), DiscardOnShutdownIsValid(), DiscardOnShutdownLogicalToDisplay(), DiscardOnShutdownLogicalToXSD(), DiscardOnShutdownNormalize(), DiscardOnShutdownSet(), DiscardOnShutdownXSDToLogical()
property Duration as %String [ Calculated ];
This property is deprecated, use property 'Timeout' instead
Property methods: DurationDisplayToLogical(), DurationGet(), DurationInSecondsDisplayToLogical(), DurationInSecondsFromNow(), DurationInSecondsGet(), DurationInSecondsGetStored(), DurationInSecondsIsValid(), DurationInSecondsLogicalToDisplay(), DurationInSecondsNormalize(), DurationInSecondsSet(), DurationInSecondsXSDToLogical(), DurationIsValid(), DurationLogicalToDisplay(), DurationLogicalToOdbc(), DurationNormalize(), DurationSet()
property DurationInSeconds as %Float;
Property methods: DurationInSecondsDisplayToLogical(), DurationInSecondsFromNow(), DurationInSecondsGet(), DurationInSecondsGetStored(), DurationInSecondsIsValid(), DurationInSecondsLogicalToDisplay(), DurationInSecondsNormalize(), DurationInSecondsSet(), DurationInSecondsXSDToLogical()
property Timeout as %String;
Timeout takes both the Duration and Until specification
Property methods: TimeoutDisplayToLogical(), TimeoutGet(), TimeoutGetStored(), TimeoutIsValid(), TimeoutLogicalToDisplay(), TimeoutLogicalToOdbc(), TimeoutNormalize(), TimeoutSet()
property Until as %String [ Calculated ];
This property is deprecated, use property 'Timeout' instead
Property methods: UntilDisplayToLogical(), UntilGet(), UntilIsValid(), UntilLogicalToDisplay(), UntilLogicalToOdbc(), UntilNormalize(), UntilSet()

Methods

method DurationGet() as %Status [ Language = objectscript ]
method DurationInSecondsFromNow() as %Float [ Language = objectscript ]
This method computes the duration-in-seconds from the current time to the set time in the future It is different from the DurationInSeconds property which is a static value equal to the duration from the time of the creation of the object to the set time in the future.
method DurationSet(pDuration As %String) as %Status [ Language = objectscript ]
method TimeoutSet(pTimeout As %String) as %Status [ Language = objectscript ]
method UntilGet() as %Status [ Language = objectscript ]
method UntilSet(pTimeout As %String) as %Status [ Language = objectscript ]
method isDuration() as %Boolean [ Language = objectscript ]

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (Ens.AlarmRequest)

^Ens.MessageBodyD(ID,"AlarmRequest")
=
Duration
DurationInSeconds
Until
DiscardOnShutdown
Timeout
FeedbackOpens in a new window