Primavera Integration API 7.0

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

java.lang.Object
  extended by com.primavera.integration.client.bo.enm.EnumType
      extended by 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
static UDFIndicator BLUE
           
static UDFIndicator GREEN
           
static UDFIndicator NONE
           
static UDFIndicator NULL
           
static UDFIndicator RED
           
static UDFIndicator YELLOW
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this UDFIndicator instance
static java.lang.String[] getEnumDescriptions()
          Gets an array of all descriptions for this enumeration
static java.lang.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(java.lang.String sUDFIndicator)
          Gets an instance of UDFIndicator based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this UDFIndicator instance
 java.lang.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 Detail

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 Detail

toString

public java.lang.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 java.lang.Object
Returns:
String a string representation of the object

getValue

public java.lang.String getValue()
Gets the internal value of this UDFIndicator instance

Specified by:
getValue in class EnumType
Returns:
String the internal value

getDescription

public java.lang.String getDescription()
Gets the description of this UDFIndicator instance

Specified by:
getDescription in class EnumType
Returns:
String the description

getUDFIndicator

public static UDFIndicator getUDFIndicator(java.lang.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 java.lang.String[] getEnumValues()
Gets an array of all internal values for this enumeration

Returns:
String[] an array of all internal values

getEnumDescriptions

public static java.lang.String[] getEnumDescriptions()
Gets an array of all descriptions for this enumeration

Returns:
String[] an array of all descriptions

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.