Package com.inductiveautomation.ignition.common.alert

Interface AlertEvent

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method 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.

      • getNotes

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

      • 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

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

      • getActiveValue

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

      • getClearedTimestamp

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

      • getClearedValue

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

      • getAcknowledgedTimestamp

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

      • getUser

        @Nullable
java.lang.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.