Primavera Integration API 7.0

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

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

public class RateType
extends EnumType

Rate type enumerations are used with resource assignments to specify which of the five prices specified for the resource will be used to calculate the cost for the resource assignment. They are also used with baseline projects and projects for specifying the default rate type to be used when adding resource assignments to a project. Valid values are 'Price / Unit', 'Price / Unit2', 'Price / Unit3', 'Price / Unit4', and 'Price / Unit5'. See also RoleRate, RateSource, and RateSourcePreference for more details on how rates can be used in cost calculation.

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 RateType COSTPERQTY
           
static RateType COSTPERQTY2
           
static RateType COSTPERQTY3
           
static RateType COSTPERQTY4
           
static RateType COSTPERQTY5
           
static RateType NULL
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this RateType 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 RateType getRateType(int iRateType)
          Gets an instance of RateType based on the integer value specified.
static RateType getRateType(java.lang.String sRateType)
          Gets an instance of RateType based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this RateType 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 RateType NULL

COSTPERQTY

public static final RateType COSTPERQTY

COSTPERQTY2

public static final RateType COSTPERQTY2

COSTPERQTY3

public static final RateType COSTPERQTY3

COSTPERQTY4

public static final RateType COSTPERQTY4

COSTPERQTY5

public static final RateType COSTPERQTY5
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 RateType instance

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

getDescription

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

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

getRateType

public static RateType getRateType(java.lang.String sRateType)
Gets an instance of RateType based on the String value specified.

Parameters:
sRateType - the internal value or description
Returns:
RateType the unique RateType instance

getRateType

public static RateType getRateType(int iRateType)
Gets an instance of RateType based on the integer value specified.

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