This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.AlertRequest


persistent class Ens.AlertRequest extends Ens.Request

SQL Table Name: Ens.AlertRequest

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property AlertDestination as %String);
Field for designating the external destination of this alert message
Property methods: AlertDestinationDisplayToLogical(), AlertDestinationGet(), AlertDestinationGetStored(), AlertDestinationIsValid(), AlertDestinationLogicalToDisplay(), AlertDestinationLogicalToOdbc(), AlertDestinationNormalize(), AlertDestinationSet()
property AlertText as %String);
Text of the alert message
Property methods: AlertTextDisplayToLogical(), AlertTextGet(), AlertTextGetStored(), AlertTextIsValid(), AlertTextLogicalToDisplay(), AlertTextLogicalToOdbc(), AlertTextNormalize(), AlertTextSet()
property AlertTime as Ens.DataType.UTC [ InitialExpression = $$$timeUTC ];
Time at which the alert was created.
Property methods: AlertTimeDisplayToLogical(), AlertTimeGet(), AlertTimeGetStored(), AlertTimeIsValid(), AlertTimeLogicalToDisplay(), AlertTimeLogicalToOdbc(), AlertTimeNormalize(), AlertTimeOdbcToLogical(), AlertTimeSet(), AlertTimeStorageToLogical(), AlertTimetimeCmp(), AlertTimetimeDiff(), AlertTimetimeLocal(), AlertTimetimeLocaltoUTC(), AlertTimetimeUTC(), AlertTimetimeUTCH(), AlertTimetimeUTCHtoUTC(), AlertTimetimeUTCtoLocal(), AlertTimetimeUTCtoUTCH()
property SessionId as %Integer;
The session in which the Alert occurred.
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdGetStored(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdNormalize(), SessionIdSet(), SessionIdXSDToLogical()
property SourceConfigName as %String (MAXLEN = 128);
Name of the business host that is sending the alert
Property methods: SourceConfigNameDisplayToLogical(), SourceConfigNameGet(), SourceConfigNameGetStored(), SourceConfigNameIsValid(), SourceConfigNameLogicalToDisplay(), SourceConfigNameLogicalToOdbc(), SourceConfigNameNormalize(), SourceConfigNameSet()

Methods (Including Private)

private method %OnNew(initvalue As %CacheString) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Inherited Members

Inherited Methods (Including Private)


Gray indicates storage defined by superclasses.

Storage Model: CacheStorage (Ens.MessageBody)


Storage Model: CacheStorage (Ens.AlertRequest)

FeedbackOpens in a new window