Primavera Integration API 7.0

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

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

public class UnitType
extends EnumType

Unit type enumerations are used with baseline projects and projects for specifying the time units associated with the project's default price per time. Valid values are 'Hour', 'Day', 'Week', 'Month', and 'Year'.

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 UnitType DAY
           
static UnitType HOUR
           
static UnitType MONTH
           
static UnitType NULL
           
static UnitType WEEK
           
static UnitType YEAR
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this UnitType 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 UnitType getUnitType(int iUnitType)
          Gets an instance of UnitType based on the integer value specified.
static UnitType getUnitType(java.lang.String sUnitType)
          Gets an instance of UnitType based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this UnitType 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 UnitType NULL

HOUR

public static final UnitType HOUR

DAY

public static final UnitType DAY

WEEK

public static final UnitType WEEK

MONTH

public static final UnitType MONTH

YEAR

public static final UnitType YEAR
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 UnitType instance

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

getDescription

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

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

getUnitType

public static UnitType getUnitType(java.lang.String sUnitType)
Gets an instance of UnitType based on the String value specified.

Parameters:
sUnitType - the internal value or description
Returns:
UnitType the unique UnitType instance

getUnitType

public static UnitType getUnitType(int iUnitType)
Gets an instance of UnitType based on the integer value specified.

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