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

Class DocumentType

java.lang.Object
com.primavera.integration.client.bo.enm.EnumType
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 Details

    • NULL

      public static final DocumentType NULL

    • NON_COLLABORATION

      public static final DocumentType NON_COLLABORATION

    • COLLABORATION

      public static final DocumentType COLLABORATION

    • REPOSITORY_DOCUMENT

      public static final DocumentType REPOSITORY_DOCUMENT

  • 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 DocumentType instance
      Specified by:
      getValue in class EnumType
      Returns:
      String the internal value

    • getDescription

      public String getDescription()
      Gets the description of this DocumentType instance
      Specified by:
      getDescription in class EnumType
      Returns:
      String the description

    • getDocumentType

      public static DocumentType getDocumentType(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 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