com.inductiveautomation.ignition.common.alert

Interface AlertEvent

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractAlertEvent, DefaultAlertEvent

Deprecated.

@Deprecated
public interface AlertEvent
extends java.io.Serializable

An AlertEvent contains the current state of an alert.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getAcknowledgedTimestamp() Deprecated. Returns the active timestamp of the alert or null if not acknowledged.
java.util.Date	getActiveTimestamp() Deprecated. Returns the active timestamp of the alert or null if not active.
java.lang.Double	getActiveValue() Deprecated. Returns the active value of the alert or null if not active.
java.util.Date	getClearedTimestamp() Deprecated. Returns the cleared timestamp of the alert or null if not cleared.
java.lang.Double	getClearedValue() Deprecated. Returns the cleared value of the alert or null if not cleared.
java.lang.String	getDisplayPath() Deprecated. Returns a user-entered path for the alert.
java.lang.String	getNotes() Deprecated. Returns user-entered notes for the alert.
java.lang.String	getPath() Deprecated. Returns the path of the source, such as the path to a SQLTag, which should be reasonably unique.
java.lang.String	getStateName() Deprecated. Returns the name of the alert state that was triggered
AlertSeverity	getStateSeverity() Deprecated. Returns the severity of the alert state
java.lang.String	getSystem() Deprecated. Returns the name of the SCADARail system responsible for the alert
java.lang.String	getUser() Deprecated. Returns a username associated with the message or null if not set.
boolean	isAcked() Deprecated.
boolean	isActive() Deprecated.
boolean	isClear() Deprecated.

Method Detail

getSystem

java.lang.String getSystem()

Deprecated.

Returns the name of the SCADARail system responsible for the alert

getPath

java.lang.String getPath()

Deprecated.

Returns the path of the source, such as the path to a SQLTag, which should be reasonably unique. That is, there should not be another alert with the same path in the same SCADARail system. This path lets alert handlers correlate ACKS and CLEARS with their initial ALERTs

getDisplayPath

java.lang.String getDisplayPath()

Deprecated.

Returns a user-entered path for the alert.

Returns:

getNotes

java.lang.String getNotes()

Deprecated.

Returns user-entered notes for the alert.

Returns:

getStateName

java.lang.String getStateName()

Deprecated.

Returns the name of the alert state that was triggered

getStateSeverity

AlertSeverity getStateSeverity()

Deprecated.

Returns the severity of the alert state

getActiveTimestamp

java.util.Date getActiveTimestamp()

Deprecated.

Returns the active timestamp of the alert or null if not active.

getActiveValue

java.lang.Double getActiveValue()

Deprecated.

Returns the active value of the alert or null if not active.

getClearedTimestamp

java.util.Date getClearedTimestamp()

Deprecated.

Returns the cleared timestamp of the alert or null if not cleared.

getClearedValue

java.lang.Double getClearedValue()

Deprecated.

Returns the cleared value of the alert or null if not cleared.

getAcknowledgedTimestamp

java.util.Date getAcknowledgedTimestamp()

Deprecated.

Returns the active timestamp of the alert or null if not acknowledged.

getUser

java.lang.String getUser()

Deprecated.

Returns a username associated with the message or null if not set. Mostly used for Acknowledegments.

isActive

boolean isActive()

Deprecated.

isClear

boolean isClear()

Deprecated.

isAcked

boolean isAcked()

Deprecated.