Package org.opennms.web.alarm

Enum AcknowledgeType

java.lang.Object

java.lang.Enum<AcknowledgeType>

org.opennms.web.alarm.AcknowledgeType

All Implemented Interfaces:

Serializable, Comparable<AcknowledgeType>

public enum AcknowledgeType
extends Enum<AcknowledgeType>

Convenience class to determine what sort of alarms to include in a query.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACKNOWLEDGED
BOTH
UNACKNOWLEDGED

Method Summary

Modifier and Type	Method	Description
static AcknowledgeType	getAcknowledgeType(String ackTypeString)	getAcknowledgeType
protected String	getAcknowledgeTypeClause()	Convenience method for getting the SQL ORDER BY clause related this sort style.
String	getName()	getName
String	getShortName()	getShortName
NormalizedAcknowledgeType	toNormalizedAcknowledgeType()
String	toString()	toString
static AcknowledgeType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AcknowledgeType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACKNOWLEDGED

public static final AcknowledgeType ACKNOWLEDGED

UNACKNOWLEDGED

public static final AcknowledgeType UNACKNOWLEDGED

BOTH

public static final AcknowledgeType BOTH

Method Detail

values

public static AcknowledgeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AcknowledgeType c : AcknowledgeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AcknowledgeType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

toString

Overrides:

toString in class Enum<AcknowledgeType>

Returns:

a String object.

getName

public String getName()

getName

Returns:

a String object.

getShortName

public String getShortName()

getShortName

Returns:

a String object.

getAcknowledgeTypeClause

protected String getAcknowledgeTypeClause()

Convenience method for getting the SQL ORDER BY clause related this sort style.

Returns:

a String object.

toNormalizedAcknowledgeType

public NormalizedAcknowledgeType toNormalizedAcknowledgeType()

getAcknowledgeType

public static AcknowledgeType getAcknowledgeType(String ackTypeString)

getAcknowledgeType

Parameters:

ackTypeString - a String object.

Returns:

a AcknowledgeType object.