public class DefaultAlertMessage extends java.lang.Object implements AlertMessage
ACKNOWLEDGED, ACTIVE, CLEARED, DEREGISTER, INFO_UPDATE, REGISTER, SUPPRESS_CLEAR_MSG
Constructor and Description |
---|
DefaultAlertMessage() |
DefaultAlertMessage(AlertMessage copy) |
DefaultAlertMessage(java.util.Date timeStamp) |
DefaultAlertMessage(java.lang.String system,
java.lang.String path,
java.lang.String stateName,
AlertSeverity stateSeverity,
java.lang.Double value,
java.util.Date timestamp,
boolean register,
boolean active,
boolean cleared,
boolean acknowledged,
java.lang.String user,
java.lang.String message,
java.lang.String displayPath,
java.lang.String notes,
AlertNotificationMode notificationMode) |
Modifier and Type | Method and Description |
---|---|
int |
getAlertFlags()
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()
Returns a user-configurable "friendly" path for the alert.
|
java.lang.String |
getMessage()
Returns the alert's custom message, if any.
|
java.lang.String |
getMessageSubject()
Returns the alerts custom subject, if any.
|
java.lang.String |
getNotes()
Get alert notes (extra information about the alert).
|
AlertNotificationMode |
getNotificationMode()
Returns the notification mode for the tag- when it wants notifications to occur.
|
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 triggered
|
AlertSeverity |
getStateSeverity()
Returns the severity of the alert state
|
java.lang.String |
getSystem()
Returns the name of the SCADARail system responsible for the alert
|
java.util.Date |
getTimestamp()
Returns the originating timestamp for the message.
|
java.lang.String |
getUser()
Returns a username associated with the message.
|
java.lang.Double |
getValue()
Returns the value that caused this alert.
|
boolean |
isAcknowledged()
Returns whether or not the message is flagged as ACKNOWLEDGED
|
boolean |
isActive()
Returns whether or not the message is flagged as ACTIVE
|
boolean |
isCleared()
Returns whether or not the message is flagged as CLEARED
|
boolean |
isDeregister()
Returns whether or not the message is flagged as DEREGISTER
|
boolean |
isRegister()
Returns whether or not the message is flagged as REGISTER
|
boolean |
isUpdate() |
void |
setAlertFlag(int flag)
Sets an alert flag to on status.
|
void |
setAlertFlag(int flag,
boolean value)
Sets an alert flag to on or off status depending on value.
|
void |
setDisplayPath(java.lang.String displayPath) |
void |
setMessage(java.lang.String message) |
void |
setMessageSubject(java.lang.String value) |
void |
setNotes(java.lang.String notes) |
void |
setNotificationMode(AlertNotificationMode notificationMode) |
void |
setPath(java.lang.String path) |
void |
setStateName(java.lang.String stateName) |
void |
setStateSeverity(AlertSeverity stateSeverity) |
void |
setSystem(java.lang.String system) |
void |
setTimestamp(java.util.Date timestamp) |
void |
setUser(java.lang.String user) |
void |
setValue(java.lang.Double value) |
boolean |
suppressClearMessage()
Returns whether or not the message is flagged as SUPPRESS_CLEAR_MSG
|
java.lang.String |
toString() |
public DefaultAlertMessage()
public DefaultAlertMessage(java.util.Date timeStamp)
public DefaultAlertMessage(AlertMessage copy)
public DefaultAlertMessage(java.lang.String system, java.lang.String path, java.lang.String stateName, AlertSeverity stateSeverity, java.lang.Double value, java.util.Date timestamp, boolean register, boolean active, boolean cleared, boolean acknowledged, java.lang.String user, java.lang.String message, java.lang.String displayPath, java.lang.String notes, AlertNotificationMode notificationMode)
public int getAlertFlags()
AlertMessage
getAlertFlags
in interface AlertMessage
public void setAlertFlag(int flag)
public void setAlertFlag(int flag, boolean value)
public java.lang.String getMessageSubject()
AlertMessage
getMessageSubject
in interface AlertMessage
public void setMessageSubject(java.lang.String value)
public java.lang.String getMessage()
AlertMessage
getMessage
in interface AlertMessage
public void setMessage(java.lang.String message)
public java.lang.String getNotes()
AlertMessage
getNotes
in interface AlertMessage
public void setNotes(java.lang.String notes)
public java.lang.String getPath()
AlertMessage
getPath
in interface AlertMessage
public void setPath(java.lang.String path)
public java.lang.String getDisplayPath()
AlertMessage
getDisplayPath
in interface AlertMessage
public void setDisplayPath(java.lang.String displayPath)
public java.lang.String getStateName()
AlertMessage
getStateName
in interface AlertMessage
public void setStateName(java.lang.String stateName)
public AlertSeverity getStateSeverity()
AlertMessage
getStateSeverity
in interface AlertMessage
public void setStateSeverity(AlertSeverity stateSeverity)
public java.lang.String getSystem()
AlertMessage
getSystem
in interface AlertMessage
public void setSystem(java.lang.String system)
public java.util.Date getTimestamp()
AlertMessage
getTimestamp
in interface AlertMessage
public void setTimestamp(java.util.Date timestamp)
public java.lang.String getUser()
AlertMessage
getUser
in interface AlertMessage
public void setUser(java.lang.String user)
public java.lang.Double getValue()
AlertMessage
getValue
in interface AlertMessage
public void setValue(java.lang.Double value)
public AlertNotificationMode getNotificationMode()
AlertMessage
getNotificationMode
in interface AlertMessage
public void setNotificationMode(AlertNotificationMode notificationMode)
public boolean isAcknowledged()
AlertMessage
isAcknowledged
in interface AlertMessage
public boolean isActive()
AlertMessage
isActive
in interface AlertMessage
public boolean isCleared()
AlertMessage
isCleared
in interface AlertMessage
public boolean isRegister()
AlertMessage
isRegister
in interface AlertMessage
public boolean isDeregister()
AlertMessage
isDeregister
in interface AlertMessage
public boolean suppressClearMessage()
AlertMessage
suppressClearMessage
in interface AlertMessage
public boolean isUpdate()
isUpdate
in interface AlertMessage
public java.lang.String toString()
toString
in class java.lang.Object