Package com.primavera.integration.client.bo.enm

Class SummarySpreadInterval

java.lang.Object

com.primavera.integration.client.bo.enm.EnumType

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

Fields

Modifier and Type	Field	Description
static final SummarySpreadInterval	MONTH
static final SummarySpreadInterval	NULL
static final SummarySpreadInterval	WEEK

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this SummarySpreadInterval instance
static String[]	getEnumDescriptions()	Gets an array of all descriptions for this enumeration
static 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(String sSummarySpreadInterval)	Gets an instance of SummarySpreadInterval based on the String value specified.
String	getValue()	Gets the internal value of this SummarySpreadInterval instance
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 Details

NULL

public static final SummarySpreadInterval NULL

MONTH

public static final SummarySpreadInterval MONTH

WEEK

public static final SummarySpreadInterval WEEK

Method Details

toString

public 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 Object

Returns:

String a string representation of the object

getValue

public String getValue()

Gets the internal value of this SummarySpreadInterval instance

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this SummarySpreadInterval instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getSummarySpreadInterval

public static SummarySpreadInterval getSummarySpreadInterval(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 String[] getEnumValues()

Gets an array of all internal values for this enumeration

Returns:

String[] an array of all internal values

getEnumDescriptions

public static String[] getEnumDescriptions()

Gets an array of all descriptions for this enumeration

Returns:

String[] an array of all descriptions