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

Modifier and Type	Method and Description
void	acknowledge(String ackUser) acknowledge
void	clear(String ackUser) clear
void	escalate(String ackUser) escalate
Integer	getAckId() getAckId
Date	getAckTime() getAckTime
String	getAckUser() getAckUser
OnmsNode	getNode() Might be null but probably supported already by most implementations, but still, here for convenience.
AckType	getType() getType
void	unacknowledge(String ackUser) unacknowledge

Method Detail

acknowledge

void acknowledge(String ackUser)

acknowledge

Parameters:

ackUser - a String object.

unacknowledge

void unacknowledge(String ackUser)

unacknowledge

Parameters:

ackUser - a String object.

clear

void clear(String ackUser)

clear

Parameters:

ackUser - a String object.

escalate

void escalate(String ackUser)

escalate

Parameters:

ackUser - a String object.

getType

AckType getType()

getType

Returns:

a AckType object.

getAckId

Integer getAckId()

getAckId

Returns:

a Integer object.

getAckUser

String getAckUser()

getAckUser

Returns:

a String object.

getAckTime

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