Primavera Integration API 7.0

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

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

public class RateSource
extends EnumType

Rate source enumerations are used to indicate which price/unit will be used to calculate costs for the assignment, such as 'Resource', 'Role', and 'Override'. When a resource and only a resource is assigned to an activity, the rate source will automatically equal 'Resource'. When a role and only a role is assigned to an activity, the rate source will automatically equal 'Role'. When both a resource and role are assigned to the activity, the rate source can be either 'Resource' or 'Role' determined by the RateSourcePreference. In any case, the 'Override' value allows you to specify any other price/unit. See also RoleRate, RateType 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 RateSource NULL
           
static RateSource OVERRIDE
           
static RateSource RESOURCE
           
static RateSource ROLE
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this RateSource 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 RateSource getRateSource(int iRateSource)
          Gets an instance of RateSource based on the integer value specified.
static RateSource getRateSource(java.lang.String sRateSource)
          Gets an instance of RateSource based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this RateSource 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 RateSource NULL

RESOURCE

public static final RateSource RESOURCE

ROLE

public static final RateSource ROLE

OVERRIDE

public static final RateSource OVERRIDE
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 RateSource instance

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

getDescription

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

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

getRateSource

public static RateSource getRateSource(java.lang.String sRateSource)
Gets an instance of RateSource based on the String value specified.

Parameters:
sRateSource - the internal value or description
Returns:
RateSource the unique RateSource instance

getRateSource

public static RateSource getRateSource(int iRateSource)
Gets an instance of RateSource based on the integer value specified.

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