com.serotonin.mango.rt.event

Class EventInstance

java.lang.Object

com.serotonin.mango.rt.event.EventInstance

public class EventInstance
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventInstance.AlternateAcknowledgementSources
static interface	EventInstance.RtnCauses

Field Summary

Fields

Modifier and Type	Field and Description
private int	acknowledgedByUserId
private java.lang.String	acknowledgedByUsername
private long	acknowledgedTimestamp
private long	activeTimestamp State field.
private int	alarmLevel Configuration field.
private int	alternateAckSource
private java.util.Map<java.lang.String,java.lang.Object>	context
private java.util.List<UserComment>	eventComments User comments on the event.
private EventType	eventType Configuration field.
private java.util.List<EventHandlerRT>	handlers
private int	id Configuration field.
private com.serotonin.web.i18n.LocalizableMessage	message Configuration field.
private boolean	rtnApplicable Configuration field.
private int	rtnCause State field.
private long	rtnTimestamp State field.
private boolean	silenced
private boolean	userNotified

Constructor Summary

Constructors

Constructor and Description
EventInstance(EventType eventType, long activeTimestamp, boolean rtnApplicable, int alarmLevel, com.serotonin.web.i18n.LocalizableMessage message, java.util.Map<java.lang.String,java.lang.Object> context)

Method Summary

Modifier and Type	Method and Description
void	addEventComment(UserComment comment)
com.serotonin.web.i18n.LocalizableMessage	getAckMessage()
int	getAcknowledgedByUserId()
java.lang.String	getAcknowledgedByUsername()
long	getAcknowledgedTimestamp()
long	getActiveTimestamp()
int	getAlarmLevel()
int	getAlternateAckSource()
java.util.Map<java.lang.String,java.lang.Object>	getContext()
java.util.List<UserComment>	getEventComments()
EventType	getEventType()
com.serotonin.web.i18n.LocalizableMessage	getExportAckMessage()
java.lang.String	getFullPrettyAcknowledgedTimestamp()
java.lang.String	getFullPrettyActiveTimestamp()
java.lang.String	getFullPrettyRtnTimestamp()
java.util.List<EventHandlerRT>	getHandlers()
int	getId()
com.serotonin.web.i18n.LocalizableMessage	getMessage()
java.lang.String	getPrettyActiveTimestamp()
java.lang.String	getPrettyRtnTimestamp()
int	getRtnCause()
com.serotonin.web.i18n.LocalizableMessage	getRtnMessage()
long	getRtnTimestamp()
boolean	isAcknowledged()
boolean	isActive()
boolean	isAlarm()
boolean	isRtnApplicable()
boolean	isSilenced()
boolean	isUserNotified()
void	returnToNormal(long time, int rtnCause)
void	setAcknowledgedByUserId(int acknowledgedByUserId)
void	setAcknowledgedByUsername(java.lang.String acknowledgedByUsername)
void	setAcknowledgedTimestamp(long acknowledgedTimestamp)
void	setAlternateAckSource(int alternateAckSource)
void	setEventComments(java.util.List<UserComment> eventComments)
void	setHandlers(java.util.List<EventHandlerRT> handlers)
void	setId(int id) This method should only be used by the EventDao for creating and updating.
void	setSilenced(boolean silenced)
void	setUserNotified(boolean userNotified)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

private int id

Configuration field. Assigned by the database.

eventType

private final EventType eventType

Configuration field. Provided by the event producer. Identifies where the event came from and what it means.

activeTimestamp

private final long activeTimestamp

State field. The time that the event became active (i.e. was raised).

rtnApplicable

private final boolean rtnApplicable

Configuration field. Is this type of event capable of returning to normal (true), or is it stateless (false).

rtnTimestamp

private long rtnTimestamp

State field. The time that the event returned to normal.

rtnCause

private int rtnCause

State field. The action that caused the event to RTN. One of EventInstance.RtnCauses

alarmLevel

private final int alarmLevel

Configuration field. The alarm level assigned to the event.

See Also:

AlarmLevels

message

private final com.serotonin.web.i18n.LocalizableMessage message

Configuration field. The message associated with the event.

eventComments

private java.util.List<UserComment> eventComments

User comments on the event. Added in the events interface after the event has been raised.

handlers

private java.util.List<EventHandlerRT> handlers

acknowledgedTimestamp

private long acknowledgedTimestamp

acknowledgedByUserId

private int acknowledgedByUserId

acknowledgedByUsername

private java.lang.String acknowledgedByUsername

alternateAckSource

private int alternateAckSource

userNotified

private boolean userNotified

silenced

private boolean silenced

context

private final java.util.Map<java.lang.String,java.lang.Object> context

Constructor Detail

EventInstance

public EventInstance(EventType eventType,
                     long activeTimestamp,
                     boolean rtnApplicable,
                     int alarmLevel,
                     com.serotonin.web.i18n.LocalizableMessage message,
                     java.util.Map<java.lang.String,java.lang.Object> context)

Method Detail

getRtnMessage

public com.serotonin.web.i18n.LocalizableMessage getRtnMessage()

getAckMessage

public com.serotonin.web.i18n.LocalizableMessage getAckMessage()

getExportAckMessage

public com.serotonin.web.i18n.LocalizableMessage getExportAckMessage()

getPrettyActiveTimestamp

public java.lang.String getPrettyActiveTimestamp()

getFullPrettyActiveTimestamp

public java.lang.String getFullPrettyActiveTimestamp()

getPrettyRtnTimestamp

public java.lang.String getPrettyRtnTimestamp()

getFullPrettyRtnTimestamp

public java.lang.String getFullPrettyRtnTimestamp()

getFullPrettyAcknowledgedTimestamp

public java.lang.String getFullPrettyAcknowledgedTimestamp()

isAlarm

public boolean isAlarm()

setId

public void setId(int id)

This method should only be used by the EventDao for creating and updating.

Parameters:

id -

isActive

public boolean isActive()

returnToNormal

public void returnToNormal(long time,
                           int rtnCause)

isAcknowledged

public boolean isAcknowledged()

getActiveTimestamp

public long getActiveTimestamp()

getAlarmLevel

public int getAlarmLevel()

getEventType

public EventType getEventType()

getId

public int getId()

getRtnTimestamp

public long getRtnTimestamp()

getMessage

public com.serotonin.web.i18n.LocalizableMessage getMessage()

isRtnApplicable

public boolean isRtnApplicable()

addEventComment

public void addEventComment(UserComment comment)

setEventComments

public void setEventComments(java.util.List<UserComment> eventComments)

getEventComments

public java.util.List<UserComment> getEventComments()

getRtnCause

public int getRtnCause()

getHandlers

public java.util.List<EventHandlerRT> getHandlers()

setHandlers

public void setHandlers(java.util.List<EventHandlerRT> handlers)

isUserNotified

public boolean isUserNotified()

setUserNotified

public void setUserNotified(boolean userNotified)

isSilenced

public boolean isSilenced()

setSilenced

public void setSilenced(boolean silenced)

getAcknowledgedTimestamp

public long getAcknowledgedTimestamp()

setAcknowledgedTimestamp

public void setAcknowledgedTimestamp(long acknowledgedTimestamp)

getAcknowledgedByUserId

public int getAcknowledgedByUserId()

setAcknowledgedByUserId

public void setAcknowledgedByUserId(int acknowledgedByUserId)

getAcknowledgedByUsername

public java.lang.String getAcknowledgedByUsername()

setAcknowledgedByUsername

public void setAcknowledgedByUsername(java.lang.String acknowledgedByUsername)

getAlternateAckSource

public int getAlternateAckSource()

setAlternateAckSource

public void setAlternateAckSource(int alternateAckSource)

getContext

public java.util.Map<java.lang.String,java.lang.Object> getContext()