wt.doc
Class DocumentType

java.lang.Object
  wt.fc.EnumeratedType
      wt.doc.DocumentType

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class DocumentType
extends EnumeratedType
implements Serializable

DocumentType is an enumeration that defines the types of documents that the system can store. Users can indicate the type when documents are created. Customers may add new document types by adding additional values to the associated resource bundle, DocumentTypeRB.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

static DocumentType	getDocumentTypeDefault() Returns the default value (instance) for the DocumentType set.
static DocumentType[]	getDocumentTypeSet() Returns a copy of the set of valid values (instances) for the DocumentType class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static DocumentType	toDocumentType(String internal_value) Returns the DocumentType instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

equals, getAbbreviatedDisplay, getDisplay, getDisplay, getFullDisplay, getLocalizedMessage, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, hashCode, isDefaultValue, isDefaultValue, isSelectable, main, toEnumeratedType, toEnumeratedType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

toDocumentType

public static DocumentType toDocumentType(String internal_value)
                                   throws WTInvalidParameterException

Returns the DocumentType instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of DocumentType.

Returns:

DocumentType

Throws:

WTInvalidParameterException

getDocumentTypeDefault

public static DocumentType getDocumentTypeDefault()

Returns the default value (instance) for the DocumentType set.

Supported API: true

Returns:

DocumentType

getDocumentTypeSet

public static DocumentType[] getDocumentTypeSet()

Returns a copy of the set of valid values (instances) for the DocumentType class.

Supported API: true

Returns:

DocumentType[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]