Package com.inductiveautomation.ignition.common.alert

Interface AlertMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultAlertMessage
@Deprecated public interface AlertMessage extends Serializable
Deprecated.
An AlertMessage is the message that is sent to and from the AlertBus.

  • Field Summary

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

  • Method Summary

    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
    String
    getDisplayPath()
    Deprecated.
    Returns a user-configurable "friendly" path for the alert.
    String
    getMessage()
    Deprecated.
    Returns the alert's custom message, if any.
    String
    getMessageSubject()
    Deprecated.
    Returns the alerts custom subject, if any.
    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.
    String
    getPath()
    Deprecated.
    Returns the path of the source, such as the path to a SQLTag, which should be reasonably unique.
    String
    getStateName()
    Deprecated.
    Returns the name of the alert state that was triggered
    AlertSeverity
    getStateSeverity()
    Deprecated.
    Returns the severity of the alert state
    String
    getSystem()
    Deprecated.
    Returns the name of the SCADARail system responsible for the alert
    Date
    getTimestamp()
    Deprecated.
    Returns the originating timestamp for the message.
    String
    getUser()
    Deprecated.
    Returns a username associated with the message.
    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 Details

  • Method Details

    • getSystem

      String getSystem()
      Deprecated.
      Returns the name of the SCADARail system responsible for the alert

    • getPath

      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

      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

      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

      Date getTimestamp()
      Deprecated.
      Returns the originating timestamp for the message.

    • getValue

      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

      String getMessageSubject()
      Deprecated.
      Returns the alerts custom subject, if any.

    • getMessage

      String getMessage()
      Deprecated.
      Returns the alert's custom message, if any.

    • getUser

      String getUser()
      Deprecated.
      Returns a username associated with the message. Mostly used for Acknowledegments

    • getNotes

      String getNotes()
      Deprecated.
      Get alert notes (extra information about the alert).