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

Class UDFIndicator

java.lang.Object

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

com.primavera.integration.client.bo.enm.UDFIndicator

public class UDFIndicator
extends EnumType

UDF indicator enumerations are used for UDFs of type Indicator. Valid values are 'Red', 'Yellow', 'Green', and 'Blue'.

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 UDFIndicator	BLUE
static final UDFIndicator	GREEN
static final UDFIndicator	NONE
static final UDFIndicator	NULL
static final UDFIndicator	RED
static final UDFIndicator	YELLOW

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this UDFIndicator 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
static UDFIndicator	getUDFIndicator(int iUDFIndicator)	Gets an instance of UDFIndicator based on the integer value specified.
static UDFIndicator	getUDFIndicator(String sUDFIndicator)	Gets an instance of UDFIndicator based on the String value specified.
String	getValue()	Gets the internal value of this UDFIndicator 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 UDFIndicator NULL

NONE

public static final UDFIndicator NONE

RED

public static final UDFIndicator RED

YELLOW

public static final UDFIndicator YELLOW

GREEN

public static final UDFIndicator GREEN

BLUE

public static final UDFIndicator BLUE

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 UDFIndicator instance

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this UDFIndicator instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getUDFIndicator

public static UDFIndicator getUDFIndicator(String sUDFIndicator)

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

Parameters:

sUDFIndicator - the internal value or description

Returns:

UDFIndicator the unique UDFIndicator instance

getUDFIndicator

public static UDFIndicator getUDFIndicator(int iUDFIndicator)

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

Parameters:

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

Returns:

UDFIndicator the unique UDFIndicator 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