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

Class DocumentStatusName

java.lang.Object

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

com.primavera.integration.client.bo.enm.DocumentStatusName

public class DocumentStatusName
extends EnumType

Document status name enumerations are status of the document. Valid values are 'Not Started', 'Under Review', 'In Progress', 'Completed', and 'On Hold'.

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 DocumentStatusName	COMPLETED
static final DocumentStatusName	IN_PROGRESS
static final DocumentStatusName	NOT_STARTED
static final DocumentStatusName	NULL
static final DocumentStatusName	ON_HOLD
static final DocumentStatusName	UNDER_REVIEW

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of this DocumentStatusName instance
static DocumentStatusName	getDocumentStatusName(int iDocumentStatusName)	Gets an instance of DocumentStatusName based on the integer value specified.
static DocumentStatusName	getDocumentStatusName(String sDocumentStatusName)	Gets an instance of DocumentStatusName 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 DocumentStatusName 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 DocumentStatusName NULL

NOT_STARTED

public static final DocumentStatusName NOT_STARTED

UNDER_REVIEW

public static final DocumentStatusName UNDER_REVIEW

IN_PROGRESS

public static final DocumentStatusName IN_PROGRESS

COMPLETED

public static final DocumentStatusName COMPLETED

ON_HOLD

public static final DocumentStatusName ON_HOLD

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

Specified by:

getValue in class EnumType

Returns:

String the internal value

getDescription

public String getDescription()

Gets the description of this DocumentStatusName instance

Specified by:

getDescription in class EnumType

Returns:

String the description

getDocumentStatusName

public static DocumentStatusName getDocumentStatusName(String sDocumentStatusName)

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

Parameters:

sDocumentStatusName - the internal value or description

Returns:

DocumentStatusName the unique DocumentStatusName instance

getDocumentStatusName

public static DocumentStatusName getDocumentStatusName(int iDocumentStatusName)

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

Parameters:

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

Returns:

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