com.filenet.api.constants
Class CompoundDocumentState
- java.lang.Object
-
- com.filenet.api.constants.CompoundDocumentState
-
- All Implemented Interfaces:
- java.io.Serializable
public final class CompoundDocumentState extends java.lang.Object implements java.io.Serializable
Defines settings that identify whether a document is a standard document or a parent component in a compound document.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static CompoundDocumentState
COMPOUND_DOCUMENT
Designates a document as the parent component in a compound document.static int
COMPOUND_DOCUMENT_AS_INT
Anint
value associated with the COMPOUND_DOCUMENT instance of this class.static CompoundDocumentState
STANDARD_DOCUMENT
Designates a document as a standard document.static int
STANDARD_DOCUMENT_AS_INT
Anint
value associated with the STANDARD_DOCUMENT instance of this class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static CompoundDocumentState
getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.int
getValue()
Returns the internal integer value associated with a specific instance of this class.java.lang.String
toString()
Returns aString
representation of this enumeration instance.
-
-
-
Field Detail
-
STANDARD_DOCUMENT_AS_INT
public static final int STANDARD_DOCUMENT_AS_INT
Anint
value associated with the STANDARD_DOCUMENT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.- See Also:
- Constant Field Values
-
STANDARD_DOCUMENT
public static final CompoundDocumentState STANDARD_DOCUMENT
Designates a document as a standard document. This setting prevents the document from being a parent component within a compound document.
-
COMPOUND_DOCUMENT_AS_INT
public static final int COMPOUND_DOCUMENT_AS_INT
Anint
value associated with the COMPOUND_DOCUMENT instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.- See Also:
- Constant Field Values
-
COMPOUND_DOCUMENT
public static final CompoundDocumentState COMPOUND_DOCUMENT
Designates a document as the parent component in a compound document. Initially, this parent component has no child components.
-
-
Method Detail
-
getValue
public int getValue()
Returns the internal integer value associated with a specific instance of this class.- Returns:
- The enumeration instance's ordinal value.
- See Also:
getInstanceFromInt(int)
-
toString
public java.lang.String toString()
Returns aString
representation of this enumeration instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- The enumeration instance's description.
-
getInstanceFromInt
public static CompoundDocumentState getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.- Parameters:
value
- The integer value. (See the *_AS_INT fields.)- Returns:
- The enumeration instance with the given ordinal value.
- Throws:
EngineRuntimeException
- If an enumeration instance with the given ordinal value does not exist.- See Also:
getValue()
-
-