All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultAlertMessage
```
@Deprecated
public interface AlertMessage
extends java.io.Serializable
```
Deprecated.

An AlertMessage is the message that is sent to and from the AlertBus.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ACKNOWLEDGED`	Deprecated.
`static int`	`ACTIVE`	Deprecated.
`static int`	`CLEARED`	Deprecated.
`static int`	`DEREGISTER`	Deprecated.
`static int`	`INFO_UPDATE`	Deprecated.
`static int`	`REGISTER`	Deprecated. These were wrong in 7.1.
`static int`	`SUPPRESS_CLEAR_MSG`	Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getAlertFlags()`	Deprecated. Returns the alert flags to determine what type of alert it is. REGISTER - 0x00000001 ACTIVE - 0x00000010 CLEARED - 0x00000100 ACKNOWLEDGED - 0x00001000 DEREGISTER - 0x00010000 SUPPRESS_CLEAR_MSG - 0x00010000
`java.lang.String`	`getDisplayPath()`	Deprecated. Returns a user-configurable "friendly" path for the alert.
`java.lang.String`	`getMessage()`	Deprecated. Returns the alert's custom message, if any.
`java.lang.String`	`getMessageSubject()`	Deprecated. Returns the alerts custom subject, if any.
`java.lang.String`	`getNotes()`	Deprecated. Get alert notes (extra information about the alert).
`AlertNotificationMode`	`getNotificationMode()`	Deprecated. Returns the notification mode for the tag- when it wants notifications to occur.
`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.util.Date`	`getTimestamp()`	Deprecated. Returns the originating timestamp for the message.
`java.lang.String`	`getUser()`	Deprecated. Returns a username associated with the message.
`java.lang.Double`	`getValue()`	Deprecated. Returns the value that caused this alert.
`boolean`	`isAcknowledged()`	Deprecated. Returns whether or not the message is flagged as ACKNOWLEDGED
`boolean`	`isActive()`	Deprecated. Returns whether or not the message is flagged as ACTIVE
`boolean`	`isCleared()`	Deprecated. Returns whether or not the message is flagged as CLEARED
`boolean`	`isDeregister()`	Deprecated. Returns whether or not the message is flagged as DEREGISTER
`boolean`	`isRegister()`	Deprecated. Returns whether or not the message is flagged as REGISTER
`boolean`	`isUpdate()`	Deprecated.
`boolean`	`suppressClearMessage()`	Deprecated. Returns whether or not the message is flagged as SUPPRESS_CLEAR_MSG

- Field Detail
  - REGISTER
```
static final int REGISTER
```
    Deprecated.
    
    These were wrong in 7.1. Now correct.
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
static final int ACTIVE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CLEARED
```
static final int CLEARED
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ACKNOWLEDGED
```
static final int ACKNOWLEDGED
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEREGISTER
```
static final int DEREGISTER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SUPPRESS_CLEAR_MSG
```
static final int SUPPRESS_CLEAR_MSG
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - INFO_UPDATE
```
static final int INFO_UPDATE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- 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-configurable "friendly" path for the alert. Configured on the tag level (so will likely be used often along with state name).
  - isRegister
```
boolean isRegister()
```
    Deprecated.
    
    Returns whether or not the message is flagged as REGISTER
  - isDeregister
```
boolean isDeregister()
```
    Deprecated.
    
    Returns whether or not the message is flagged as DEREGISTER
  - isActive
```
boolean isActive()
```
    Deprecated.
    
    Returns whether or not the message is flagged as ACTIVE
  - isCleared
```
boolean isCleared()
```
    Deprecated.
    
    Returns whether or not the message is flagged as CLEARED
  - isAcknowledged
```
boolean isAcknowledged()
```
    Deprecated.
    
    Returns whether or not the message is flagged as ACKNOWLEDGED
  - isUpdate
```
boolean isUpdate()
```
    Deprecated.
  - suppressClearMessage
```
boolean suppressClearMessage()
```
    Deprecated.
    
    Returns whether or not the message is flagged as SUPPRESS_CLEAR_MSG
  - getAlertFlags
```
int getAlertFlags()
```
    Deprecated.
    Returns the alert flags to determine what type of alert it is.
    
    REGISTER - 0x00000001
    
    ACTIVE - 0x00000010
    
    CLEARED - 0x00000100
    
    ACKNOWLEDGED - 0x00001000
    
    DEREGISTER - 0x00010000
    
    SUPPRESS_CLEAR_MSG - 0x00010000
  - 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
  - getTimestamp
```
java.util.Date getTimestamp()
```
    Deprecated.
    
    Returns the originating timestamp for the message.
  - getValue
```
java.lang.Double getValue()
```
    Deprecated.
    
    Returns the value that caused this alert. May not be applicable for all message types
  - getNotificationMode
```
AlertNotificationMode getNotificationMode()
```
    Deprecated.
    
    Returns the notification mode for the tag- when it wants notifications to occur.
  - getMessageSubject
```
java.lang.String getMessageSubject()
```
    Deprecated.
    
    Returns the alerts custom subject, if any.
  - getMessage
```
java.lang.String getMessage()
```
    Deprecated.
    
    Returns the alert's custom message, if any.
  - getUser
```
java.lang.String getUser()
```
    Deprecated.
    
    Returns a username associated with the message. Mostly used for Acknowledegments
  - getNotes
```
java.lang.String getNotes()
```
    Deprecated.
    
    Get alert notes (extra information about the alert).

Interface AlertMessage

Field Summary

Method Summary

Field Detail

REGISTER

ACTIVE

CLEARED

ACKNOWLEDGED

DEREGISTER

SUPPRESS_CLEAR_MSG

INFO_UPDATE

Method Detail

getSystem

getPath

getDisplayPath

isRegister

isDeregister

isActive

isCleared

isAcknowledged

isUpdate

suppressClearMessage

getAlertFlags

getStateName

getStateSeverity

getTimestamp

getValue

getNotificationMode

getMessageSubject

getMessage

getUser

getNotes