Class DefaultAlertEvent
- java.lang.Object
-
- com.inductiveautomation.ignition.common.alert.AbstractAlertEvent
-
- com.inductiveautomation.ignition.common.alert.DefaultAlertEvent
-
- All Implemented Interfaces:
AlertEvent
,java.io.Serializable
public class DefaultAlertEvent extends AbstractAlertEvent
A simple immutable implementation of AlertEvent- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultAlertEvent(AlertEvent event)
DefaultAlertEvent(java.lang.String system, java.lang.String path, java.lang.String stateName, AlertSeverity stateSeverity, java.lang.Double activeValue, java.util.Date activeTimestamp, java.lang.Double clearedValue, java.util.Date clearedTimestamp, java.lang.String user, java.util.Date acknowledgedTimestamp, java.lang.String displayPath, java.lang.String notes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.util.Date
getAcknowledgedTimestamp()
Returns the active timestamp of the alert ornull
if not acknowledged.java.util.Date
getActiveTimestamp()
Returns the active timestamp of the alert ornull
if not active.java.lang.Double
getActiveValue()
Returns the active value of the alert ornull
if not active.java.util.Date
getClearedTimestamp()
Returns the cleared timestamp of the alert ornull
if not cleared.java.lang.Double
getClearedValue()
Returns the cleared value of the alert ornull
if not cleared.java.lang.String
getDisplayPath()
Returns a user-entered path for the alert.java.lang.String
getNotes()
Returns user-entered notes for the alert.java.lang.String
getPath()
Returns the path of the source, such as the path to a SQLTag, which should be reasonably unique.java.lang.String
getStateName()
Returns the name of the alert state that was triggeredAlertSeverity
getStateSeverity()
Returns the severity of the alert statejava.lang.String
getSystem()
Returns the name of the SCADARail system responsible for the alertjava.lang.String
getUser()
Returns a username associated with the message ornull
if not set.int
hashCode()
java.lang.String
toString()
-
Methods inherited from class com.inductiveautomation.ignition.common.alert.AbstractAlertEvent
isAcked, isActive, isClear
-
-
-
-
Constructor Detail
-
DefaultAlertEvent
public DefaultAlertEvent(AlertEvent event)
-
DefaultAlertEvent
public DefaultAlertEvent(java.lang.String system, java.lang.String path, java.lang.String stateName, AlertSeverity stateSeverity, java.lang.Double activeValue, java.util.Date activeTimestamp, java.lang.Double clearedValue, java.util.Date clearedTimestamp, java.lang.String user, java.util.Date acknowledgedTimestamp, java.lang.String displayPath, java.lang.String notes)
-
-
Method Detail
-
getAcknowledgedTimestamp
public java.util.Date getAcknowledgedTimestamp()
Description copied from interface:AlertEvent
Returns the active timestamp of the alert ornull
if not acknowledged.
-
getActiveTimestamp
public java.util.Date getActiveTimestamp()
Description copied from interface:AlertEvent
Returns the active timestamp of the alert ornull
if not active.
-
getActiveValue
public java.lang.Double getActiveValue()
Description copied from interface:AlertEvent
Returns the active value of the alert ornull
if not active.
-
getClearedTimestamp
public java.util.Date getClearedTimestamp()
Description copied from interface:AlertEvent
Returns the cleared timestamp of the alert ornull
if not cleared.
-
getClearedValue
public java.lang.Double getClearedValue()
Description copied from interface:AlertEvent
Returns the cleared value of the alert ornull
if not cleared.
-
getPath
public java.lang.String getPath()
Description copied from interface:AlertEvent
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
public java.lang.String getDisplayPath()
Description copied from interface:AlertEvent
Returns a user-entered path for the alert.
-
getNotes
public java.lang.String getNotes()
Description copied from interface:AlertEvent
Returns user-entered notes for the alert.
-
getStateName
public java.lang.String getStateName()
Description copied from interface:AlertEvent
Returns the name of the alert state that was triggered
-
getStateSeverity
public AlertSeverity getStateSeverity()
Description copied from interface:AlertEvent
Returns the severity of the alert state
-
getSystem
public java.lang.String getSystem()
Description copied from interface:AlertEvent
Returns the name of the SCADARail system responsible for the alert
-
getUser
public java.lang.String getUser()
Description copied from interface:AlertEvent
Returns a username associated with the message ornull
if not set. Mostly used for Acknowledgements.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-