Primavera Integration API 7.0

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

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

public class SpreadPeriodType
extends EnumType

Spread period type enumerations are used to specify the spread interval for EPS, project, WBS, Activity, and resource assignment spreads. Valid values are 'Hour', 'Day', 'Week', 'Month', 'Quarter', 'Year' and 'FinancialPeriod'.

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 SpreadPeriodType DAY
           
static SpreadPeriodType FINANCIALPERIOD
           
static SpreadPeriodType HOUR
           
static SpreadPeriodType MONTH
           
static SpreadPeriodType NULL
           
static SpreadPeriodType QUARTER
           
static SpreadPeriodType WEEK
           
static SpreadPeriodType YEAR
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this SpreadPeriodType 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 SpreadPeriodType getSpreadPeriodType(int iSpreadPeriodType)
          Gets an instance of SpreadPeriodType based on the integer value specified.
static SpreadPeriodType getSpreadPeriodType(java.lang.String sSpreadPeriodType)
          Gets an instance of SpreadPeriodType based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this SpreadPeriodType 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 SpreadPeriodType NULL

HOUR

public static final SpreadPeriodType HOUR

DAY

public static final SpreadPeriodType DAY

WEEK

public static final SpreadPeriodType WEEK

MONTH

public static final SpreadPeriodType MONTH

QUARTER

public static final SpreadPeriodType QUARTER

YEAR

public static final SpreadPeriodType YEAR

FINANCIALPERIOD

public static final SpreadPeriodType FINANCIALPERIOD
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 SpreadPeriodType instance

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

getDescription

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

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

getSpreadPeriodType

public static SpreadPeriodType getSpreadPeriodType(java.lang.String sSpreadPeriodType)
Gets an instance of SpreadPeriodType based on the String value specified.

Parameters:
sSpreadPeriodType - the internal value or description
Returns:
SpreadPeriodType the unique SpreadPeriodType instance

getSpreadPeriodType

public static SpreadPeriodType getSpreadPeriodType(int iSpreadPeriodType)
Gets an instance of SpreadPeriodType based on the integer value specified.

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