Package org.opennms.netmgt.model
Interface Acknowledgeable
-
- All Known Implementing Classes:
OnmsAlarm
,OnmsNotification
public interface Acknowledgeable
Entities that have the capability of being acknowledge should implement this interface for Ackd acknowledgment behavior.- Version:
- $Id: $
- Author:
- Jeff Gehlbach, David Hustace, Jeff Gehlbach, David Hustace
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
acknowledge(java.lang.String ackUser)
acknowledgevoid
clear(java.lang.String ackUser)
clearvoid
escalate(java.lang.String ackUser)
escalatejava.lang.Integer
getAckId()
getAckIdjava.util.Date
getAckTime()
getAckTimejava.lang.String
getAckUser()
getAckUserOnmsNode
getNode()
Might be null but probably supported already by most implementations, but still, here for convenience.OnmsSeverity
getSeverity()
AckType
getType()
getTypevoid
unacknowledge(java.lang.String ackUser)
unacknowledge
-
-
-
Method Detail
-
acknowledge
void acknowledge(java.lang.String ackUser)
acknowledge
- Parameters:
ackUser
- aString
object.
-
unacknowledge
void unacknowledge(java.lang.String ackUser)
unacknowledge
- Parameters:
ackUser
- aString
object.
-
clear
void clear(java.lang.String ackUser)
clear
- Parameters:
ackUser
- aString
object.
-
escalate
void escalate(java.lang.String ackUser)
escalate
- Parameters:
ackUser
- aString
object.
-
getAckId
java.lang.Integer getAckId()
getAckId
- Returns:
- a
Integer
object.
-
getAckUser
java.lang.String getAckUser()
getAckUser
- Returns:
- a
String
object.
-
getAckTime
java.util.Date getAckTime()
getAckTime
- Returns:
- a
Date
object.
-
getNode
OnmsNode getNode()
Might be null but probably supported already by most implementations, but still, here for convenience. Also guarantees that this is available in this API if the model changes where the node is not directly related and de-facto support is removed.- Returns:
- the related OnmsNode, null if non available or doesn't make sense
-
getSeverity
OnmsSeverity getSeverity()
-
-