|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.DocClassificationStatus
public final class DocClassificationStatus
Provides a set of constants that specify the auto-classification status of a document. These constants are used in conjunction with the ClassificationStatus property to provide client applications a means of discovering whether a particular document is subject to auto-classification, and if so, whether or not the operation was successful.
Field Summary | |
---|---|
static DocClassificationStatus |
CLASSIFICATION_COMPLETE
Specifies that auto-classification of the document has completed successfully. |
static int |
CLASSIFICATION_COMPLETE_AS_INT
An int value associated with the CLASSIFICATION_COMPLETE instance of this class. |
static DocClassificationStatus |
CLASSIFICATION_FAILED
Specifies that auto-classification of the document has failed. |
static int |
CLASSIFICATION_FAILED_AS_INT
An int value associated with the CLASSIFICATION_FAILED instance of this class. |
static DocClassificationStatus |
CLASSIFICATION_PENDING
Specifies that a request for auto-classification of the document is pending. |
static int |
CLASSIFICATION_PENDING_AS_INT
An int value associated with the CLASSIFICATION_PENDING instance of this class. |
static DocClassificationStatus |
NOT_CLASSIFIED
Specifies that auto-classification of the document has not been requested. |
static int |
NOT_CLASSIFIED_AS_INT
An int value associated with the NOT_CLASSIFIED instance of this class. |
Method Summary | |
---|---|
static DocClassificationStatus |
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 a String representation of this enumeration instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int CLASSIFICATION_COMPLETE_AS_INT
int
value associated with the CLASSIFICATION_COMPLETE 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.
public static final DocClassificationStatus CLASSIFICATION_COMPLETE
public static final int CLASSIFICATION_FAILED_AS_INT
int
value associated with the CLASSIFICATION_FAILED 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.
public static final DocClassificationStatus CLASSIFICATION_FAILED
public static final int NOT_CLASSIFIED_AS_INT
int
value associated with the NOT_CLASSIFIED 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.
public static final DocClassificationStatus NOT_CLASSIFIED
checkin
method's autoClassify
parameter
to DO_NOT_AUTO_CLASSIFY
.
public static final int CLASSIFICATION_PENDING_AS_INT
int
value associated with the CLASSIFICATION_PENDING 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.
public static final DocClassificationStatus CLASSIFICATION_PENDING
checkin
method's autoClassify
parameter
to AUTO_CLASSIFY
.
Method Detail |
---|
public int getValue()
getInstanceFromInt(int)
public java.lang.String toString()
String
representation of this enumeration instance.
toString
in class java.lang.Object
public static DocClassificationStatus getInstanceFromInt(int value)
value
- The integer value. (See the *_AS_INT fields.)
EngineRuntimeException
- If an enumeration instance with the given
ordinal value does not exist.getValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |