Primavera Integration API Release 8

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

java.lang.Object
  extended by com.primavera.integration.client.bo.enm.EnumType
      extended by com.primavera.integration.client.bo.enm.UDFSummaryMethodType

public class UDFSummaryMethodType
extends EnumType

The summary method type for the user-defined field summary method. Valid values are "None", "Average", "Calc", "Min", "Max", "Sum".

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 UDFSummaryMethodType AVERAGE
           
static UDFSummaryMethodType CALC
           
static UDFSummaryMethodType MAX
           
static UDFSummaryMethodType MIN
           
static UDFSummaryMethodType NONE
           
static UDFSummaryMethodType NULL
           
static UDFSummaryMethodType SUM
           
 
Method Summary
 String getDescription()
          Gets the description of this UDFSummaryMethodType 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 UDFSummaryMethodType getUDFSummaryMethodType(int iUDFSummaryMethodType)
          Gets an instance of UDFSummaryMethodType based on the integer value specified.
static UDFSummaryMethodType getUDFSummaryMethodType(String sUDFSummaryMethodType)
          Gets an instance of UDFSummaryMethodType based on the String value specified.
 String getValue()
          Gets the internal value of this UDFSummaryMethodType 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 Detail

NULL

public static final UDFSummaryMethodType NULL

NONE

public static final UDFSummaryMethodType NONE

AVERAGE

public static final UDFSummaryMethodType AVERAGE

CALC

public static final UDFSummaryMethodType CALC

MIN

public static final UDFSummaryMethodType MIN

MAX

public static final UDFSummaryMethodType MAX

SUM

public static final UDFSummaryMethodType SUM
Method Detail

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

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

getDescription

public String getDescription()
Gets the description of this UDFSummaryMethodType instance

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

getUDFSummaryMethodType

public static UDFSummaryMethodType getUDFSummaryMethodType(String sUDFSummaryMethodType)
Gets an instance of UDFSummaryMethodType based on the String value specified.

Parameters:
sUDFSummaryMethodType - the internal value or description
Returns:
UDFSummaryMethodType the unique UDFSummaryMethodType instance

getUDFSummaryMethodType

public static UDFSummaryMethodType getUDFSummaryMethodType(int iUDFSummaryMethodType)
Gets an instance of UDFSummaryMethodType based on the integer value specified.

Parameters:
iUDFSummaryMethodType - an integer representing a particular value of this class. This value is also used when exporting to XML.
Returns:
UDFSummaryMethodType the unique UDFSummaryMethodType 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

Primavera Integration API Release 8

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