Content Engine Java API: IndexRequestStatus

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

All Implemented Interfaces:

java.io.Serializable
```
public final class IndexRequestStatus
extends java.lang.Object
implements java.io.Serializable
```
Indicates the status of an index request. The status value will be updated by the indexing process.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static IndexRequestStatus`	`IN_PROGRESS` Indicates the index request is currently in progress.
`static int`	`IN_PROGRESS_AS_INT` An `int` value associated with the IN_PROGRESS instance of this class.
`static IndexRequestStatus`	`NOT_STARTED` Indicates the index request has not yet started.
`static int`	`NOT_STARTED_AS_INT` An `int` value associated with the NOT_STARTED instance of this class.
`static IndexRequestStatus`	`PAUSED` Indicates the index request is paused.
`static int`	`PAUSED_AS_INT` An `int` value associated with the PAUSED instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static IndexRequestStatus`	`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
  - NOT_STARTED_AS_INT
```
public static final int NOT_STARTED_AS_INT
```
    An int value associated with the NOT_STARTED 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_STARTED
```
public static final IndexRequestStatus NOT_STARTED
```
    Indicates the index request has not yet started.
  - IN_PROGRESS_AS_INT
```
public static final int IN_PROGRESS_AS_INT
```
    An int value associated with the IN_PROGRESS 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
  - IN_PROGRESS
```
public static final IndexRequestStatus IN_PROGRESS
```
    Indicates the index request is currently in progress.
  - PAUSED_AS_INT
```
public static final int PAUSED_AS_INT
```
    An int value associated with the PAUSED 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
  - PAUSED
```
public static final IndexRequestStatus PAUSED
```
    Indicates the index request is paused.
- 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 IndexRequestStatus 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

NOT_STARTED_AS_INT

NOT_STARTED

IN_PROGRESS_AS_INT

IN_PROGRESS

PAUSED_AS_INT

PAUSED

getValue

toString

getInstanceFromInt