Primavera Integration API 7.0

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

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

public class DocumentType
extends EnumType

DocumentType enumerations indicate whether a document is a collaboration or a non-collaboration document. Valid values are 'Non-Collaboration' and 'Collaboration'.

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 DocumentType COLLABORATION
           
static DocumentType NON_COLLABORATION
           
static DocumentType NULL
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this DocumentType instance
static DocumentType getDocumentType(int iDocumentType)
          Gets an instance of DocumentType based on the integer value specified.
static DocumentType getDocumentType(java.lang.String sDocumentType)
          Gets an instance of DocumentType based on the String value specified.
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
 java.lang.String getValue()
          Gets the internal value of this DocumentType 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 DocumentType NULL

NON_COLLABORATION

public static final DocumentType NON_COLLABORATION

COLLABORATION

public static final DocumentType COLLABORATION
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 DocumentType instance

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

getDescription

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

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

getDocumentType

public static DocumentType getDocumentType(java.lang.String sDocumentType)
Gets an instance of DocumentType based on the String value specified.

Parameters:
sDocumentType - the internal value or description
Returns:
DocumentType the unique DocumentType instance

getDocumentType

public static DocumentType getDocumentType(int iDocumentType)
Gets an instance of DocumentType based on the integer value specified.

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