%SYS.Monitor.AbstractNotification

abstract class %SYS.Monitor.AbstractNotification extends %Library.RegisteredObject

User classes inherit from this class to become a Notifier for System Monitor.

Property Inventory

• Notifications
• State

Method Inventory

• ClearNotifications()
• GetNextNotification()
• LogCon()
• LogMsg()
• OpenLog()
• Post()
• Start()

Properties

property Notifications [ MultiDimensional ];

Property methods: NotificationsDisplayToLogical(), NotificationsGet(), NotificationsIsValid(), NotificationsLogicalToDisplay(), NotificationsLogicalToOdbc(), NotificationsNormalize(), NotificationsSet()

property State as %String [ InitialExpression = " " ];

Runtime state

Property methods: StateDisplayToLogical(), StateGet(), StateIsValid(), StateLogicalToDisplay(), StateLogicalToOdbc(), StateNormalize(), StateSet()

Methods

final method ClearNotifications() as %Integer

USER DOES NOT IMPLEMENT THIS METHOD This method is called to clear notifications for the SYS.Monitor Controller

method GetNextNotification(ByRef Sensor As %String = "", Output Severity As %Integer, Output Msg As %String) as %Status

Get Next Notification

final method LogCon(Msg As %String = "", Severity As %Integer = 0) as %Status

final method LogMsg(msg As %String = "") as %Status

final method OpenLog() as %Status

abstract method Post() as %Status

USER MUST IMPLEMENT THIS METHOD Post a notification

method Start() as %Status

USER MAY IMPLEMENT THIS METHOD This method is called when the notifier class is created.