Content Engine Java API: DocClassificationStatus

java.lang.Object
- com.filenet.api.constants.DocClassificationStatus

All Implemented Interfaces:

java.io.Serializable
```
public final class DocClassificationStatus
extends java.lang.Object
implements java.io.Serializable
```
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.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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

Methods
Modifier and Type	Method and Description
`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
  - CLASSIFICATION_COMPLETE_AS_INT
```
public static final int CLASSIFICATION_COMPLETE_AS_INT
```
    An 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.
    
    See Also:
    Constant Field Values
  - CLASSIFICATION_COMPLETE
```
public static final DocClassificationStatus CLASSIFICATION_COMPLETE
```
    Specifies that auto-classification of the document has completed successfully.
  - CLASSIFICATION_FAILED_AS_INT
```
public static final int CLASSIFICATION_FAILED_AS_INT
```
    An 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.
    
    See Also:
    Constant Field Values
  - CLASSIFICATION_FAILED
```
public static final DocClassificationStatus CLASSIFICATION_FAILED
```
    Specifies that auto-classification of the document has failed.
  - NOT_CLASSIFIED_AS_INT
```
public static final int NOT_CLASSIFIED_AS_INT
```
    An 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.
    
    See Also:
    Constant Field Values
  - NOT_CLASSIFIED
```
public static final DocClassificationStatus NOT_CLASSIFIED
```
    Specifies that auto-classification of the document has not been requested. This value is set automatically by the server when you check in a document and set its checkin method's autoClassify parameter to DO_NOT_AUTO_CLASSIFY.
  - CLASSIFICATION_PENDING_AS_INT
```
public static final int CLASSIFICATION_PENDING_AS_INT
```
    An 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.
    
    See Also:
    Constant Field Values
  - CLASSIFICATION_PENDING
```
public static final DocClassificationStatus CLASSIFICATION_PENDING
```
    Specifies that a request for auto-classification of the document is pending. This value is automatically set by the server when you check in a document and set its checkin method's autoClassify parameter to AUTO_CLASSIFY.
- 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 a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The enumeration instance's description.
  - getInstanceFromInt
```
public static DocClassificationStatus 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()

Methods inherited from class java.lang.Object

CLASSIFICATION_COMPLETE_AS_INT

CLASSIFICATION_COMPLETE

CLASSIFICATION_FAILED_AS_INT

CLASSIFICATION_FAILED

NOT_CLASSIFIED_AS_INT

NOT_CLASSIFIED

CLASSIFICATION_PENDING_AS_INT

CLASSIFICATION_PENDING

getValue

toString

getInstanceFromInt