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

Class DiscountApplicationPeriod

java.lang.Object

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

com.primavera.integration.client.bo.enm.DiscountApplicationPeriod

public class DiscountApplicationPeriod
extends EnumType

Discount application period enumerations are used with baseline projects and projects to specify the timescale for entering ROI spending and benefit plan. Valid values are 'Month', 'Quarter', or '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

Fields

Modifier and Type	Field	Description
static final DiscountApplicationPeriod	MONTH
static final DiscountApplicationPeriod	NULL
static final DiscountApplicationPeriod	QUARTER
static final DiscountApplicationPeriod	YEAR

Method Summary

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

MONTH

public static final DiscountApplicationPeriod MONTH

QUARTER

public static final DiscountApplicationPeriod QUARTER

YEAR

public static final DiscountApplicationPeriod YEAR

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

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this DiscountApplicationPeriod instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getDiscountApplicationPeriod

public static DiscountApplicationPeriod getDiscountApplicationPeriod(String sDiscountApplicationPeriod)

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

Parameters:

sDiscountApplicationPeriod - the internal value or description

Returns:

DiscountApplicationPeriod the unique DiscountApplicationPeriod instance

getDiscountApplicationPeriod

public static DiscountApplicationPeriod getDiscountApplicationPeriod(int iDiscountApplicationPeriod)

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

Parameters:

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

Returns:

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