Primavera Integration API 7.0

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

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

public class SummarySpreadInterval
extends EnumType

Summary spread interval enumerations are used with global preferences for specifying the interval in which to summarize and store WBS, resource, and role level spreads. Valid values are 'Month' and 'Week'.

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 SummarySpreadInterval MONTH
           
static SummarySpreadInterval NULL
           
static SummarySpreadInterval WEEK
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this SummarySpreadInterval 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 SummarySpreadInterval getSummarySpreadInterval(int iSummarySpreadInterval)
          Gets an instance of SummarySpreadInterval based on the integer value specified.
static SummarySpreadInterval getSummarySpreadInterval(java.lang.String sSummarySpreadInterval)
          Gets an instance of SummarySpreadInterval based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this SummarySpreadInterval 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 SummarySpreadInterval NULL

MONTH

public static final SummarySpreadInterval MONTH

WEEK

public static final SummarySpreadInterval WEEK
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 SummarySpreadInterval instance

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

getDescription

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

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

getSummarySpreadInterval

public static SummarySpreadInterval getSummarySpreadInterval(java.lang.String sSummarySpreadInterval)
Gets an instance of SummarySpreadInterval based on the String value specified.

Parameters:
sSummarySpreadInterval - the internal value or description
Returns:
SummarySpreadInterval the unique SummarySpreadInterval instance

getSummarySpreadInterval

public static SummarySpreadInterval getSummarySpreadInterval(int iSummarySpreadInterval)
Gets an instance of SummarySpreadInterval based on the integer value specified.

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