Package com.inductiveautomation.ignition.common.alert

Interface AlertEvent

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractAlertEvent, DefaultAlertEvent
@Deprecated public interface AlertEvent extends Serializable
Deprecated.
An AlertEvent contains the current state of an alert.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Date
    getAcknowledgedTimestamp()
    Deprecated.
    Returns the active timestamp of the alert or null if not acknowledged.
    @Nullable Date
    getActiveTimestamp()
    Deprecated.
    Returns the active timestamp of the alert or null if not active.
    @Nullable Double
    getActiveValue()
    Deprecated.
    Returns the active value of the alert or null if not active.
    @Nullable Date
    getClearedTimestamp()
    Deprecated.
    Returns the cleared timestamp of the alert or null if not cleared.
    @Nullable Double
    getClearedValue()
    Deprecated.
    Returns the cleared value of the alert or null if not cleared.
    String
    getDisplayPath()
    Deprecated.
    Returns a user-entered path for the alert.
    String
    getNotes()
    Deprecated.
    Returns user-entered notes for the alert.
    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
    @Nullable 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 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-entered path for the alert.

    • getNotes

      String getNotes()
      Deprecated.
      Returns user-entered notes for the alert.

    • 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

    • getActiveTimestamp

      @Nullable Date getActiveTimestamp()
      Deprecated.
      Returns the active timestamp of the alert or null if not active.

    • getActiveValue

      @Nullable Double getActiveValue()
      Deprecated.
      Returns the active value of the alert or null if not active.

    • getClearedTimestamp

      @Nullable Date getClearedTimestamp()
      Deprecated.
      Returns the cleared timestamp of the alert or null if not cleared.

    • getClearedValue

      @Nullable Double getClearedValue()
      Deprecated.
      Returns the cleared value of the alert or null if not cleared.

    • getAcknowledgedTimestamp

      @Nullable Date getAcknowledgedTimestamp()
      Deprecated.
      Returns the active timestamp of the alert or null if not acknowledged.

    • getUser

      @Nullable String getUser()
      Deprecated.
      Returns a username associated with the message or null if not set. Mostly used for Acknowledgements.

    • isActive

      boolean isActive()
      Deprecated.

    • isClear

      boolean isClear()
      Deprecated.

    • isAcked

      boolean isAcked()
      Deprecated.