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

Class HistoryInterval

java.lang.Object

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

com.primavera.integration.client.bo.enm.HistoryInterval

public class HistoryInterval
extends EnumType

Specify how historical project data is stored for use in P6 Analytics.

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 HistoryInterval	FINANCIAL_PERIOD
static final HistoryInterval	MONTH
static final HistoryInterval	NULL
static final HistoryInterval	QUARTER
static final HistoryInterval	WEEK
static final HistoryInterval	YEAR

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this HistoryInterval 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 HistoryInterval	getHistoryInterval(int iHistoryInterval)	Gets an instance of HistoryInterval based on the integer value specified.
static HistoryInterval	getHistoryInterval(String sHistoryInterval)	Gets an instance of HistoryInterval based on the String value specified.
String	getValue()	Gets the internal value of this HistoryInterval 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 HistoryInterval NULL

MONTH

public static final HistoryInterval MONTH

WEEK

public static final HistoryInterval WEEK

QUARTER

public static final HistoryInterval QUARTER

YEAR

public static final HistoryInterval YEAR

FINANCIAL_PERIOD

public static final HistoryInterval FINANCIAL_PERIOD

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 HistoryInterval instance

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this HistoryInterval instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getHistoryInterval

public static HistoryInterval getHistoryInterval(String sHistoryInterval)

Gets an instance of HistoryInterval based on the String value specified.

Parameters:

sHistoryInterval - the internal value or description

Returns:

HistoryInterval the unique HistoryInterval instance

getHistoryInterval

public static HistoryInterval getHistoryInterval(int iHistoryInterval)

Gets an instance of HistoryInterval based on the integer value specified.

Parameters:

iHistoryInterval - an integer representing a particular value of this class. This value is also used when exporting to XML.

Returns:

HistoryInterval the unique HistoryInterval 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