Package com.primavera.integration.client.bo.enm

Class AlertStatus

java.lang.Object

com.primavera.integration.client.bo.enm.EnumType

com.primavera.integration.client.bo.enm.AlertStatus

public class AlertStatus
extends EnumType

Alert status enumerations are used with Alerts. They are used for acknowledging the alert status.The type can be either 'New' or 'Viewed'.

To use an enumeration in a where clause, make sure you use the internal database value. This can be retrieved from a particular enum instance by calling getValue().

Field Summary

Fields

Modifier and Type	Field	Description
static final AlertStatus	NEW
static final AlertStatus	NULL
static final AlertStatus	VIEWED

Method Summary

Modifier and Type	Method	Description
static AlertStatus	getAlertStatus(int iAlertStatus)	Gets an instance of AlertStatus based on the integer value specified.
static AlertStatus	getAlertStatus(String sAlertStatus)	Gets an instance of AlertStatus based on the String value specified.
String	getDescription()	Gets the description of this AlertStatus instance
static String[]	getEnumDescriptions()	Gets an array of all descriptions for this enumeration
static String[]	getEnumValues()	Gets an array of all internal values for this enumeration
String	getValue()	Gets the internal value of this AlertStatus instance
String	toString()	Returns a string representation of the object, which is the same as the description returned by the getDescription() method

Methods inherited from class com.primavera.integration.client.bo.enm.EnumType

equals, hashCode, intValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

NULL

public static final AlertStatus NULL

NEW

public static final AlertStatus NEW

VIEWED

public static final AlertStatus VIEWED

Method Details

toString

public String toString()

Returns a string representation of the object, which is the same as the description returned by the getDescription() method

Overrides:

toString in class Object

Returns:

String a string representation of the object

getValue

public String getValue()

Gets the internal value of this AlertStatus instance

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this AlertStatus instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getAlertStatus

public static AlertStatus getAlertStatus(String sAlertStatus)

Gets an instance of AlertStatus based on the String value specified.

Parameters:

sAlertStatus - the internal value or description

Returns:

AlertStatus the unique AlertStatus instance

getAlertStatus

public static AlertStatus getAlertStatus(int iAlertStatus)

Gets an instance of AlertStatus based on the integer value specified.

Parameters:

iAlertStatus - an integer representing a particular value of this class. This value is also used when exporting to XML.

Returns:

AlertStatus the unique AlertStatus instance

getEnumValues

public static String[] getEnumValues()

Gets an array of all internal values for this enumeration

Returns:

String[] an array of all internal values

getEnumDescriptions

public static String[] getEnumDescriptions()

Gets an array of all descriptions for this enumeration

Returns:

String[] an array of all descriptions