Content Engine Java API: IndexJobStatus

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

All Implemented Interfaces:

java.io.Serializable
```
public final class IndexJobStatus
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that are used by the JobStatus property of an IndexJob object to identify the status of an index job.

See Also:
IndexJob, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static IndexJobStatus`	`ABORT_IN_PROGRESS` A request to cancel the indexing job has been submitted (`IndexJob.set_JobAbortRequested`), and the cancel operation is currently in progress.
`static int`	`ABORT_IN_PROGRESS_AS_INT` An `int` value associated with the ABORT_IN_PROGRESS instance of this class.
`static IndexJobStatus`	`CANCELED` The indexing job was canceled by an administrator.
`static int`	`CANCELED_AS_INT` An `int` value associated with the CANCELED instance of this class.
`static IndexJobStatus`	`IN_PROGRESS` The indexing job is currently in progress.
`static int`	`IN_PROGRESS_AS_INT` An `int` value associated with the IN_PROGRESS instance of this class.
`static IndexJobStatus`	`PAUSED` A request to pause the indexing job has been submitted (`IndexJob.set_JobPauseRequested`) and the indexing job has been paused.
`static int`	`PAUSED_AS_INT` An `int` value associated with the PAUSED instance of this class.
`static IndexJobStatus`	`PENDING` The indexing job request has been submitted and is currently pending.
`static int`	`PENDING_AS_INT` An `int` value associated with the PENDING instance of this class.
`static IndexJobStatus`	`TERMINATED_ABNORMALLY` The indexing job was terminated before completion due to an unexpected error.
`static int`	`TERMINATED_ABNORMALLY_AS_INT` An `int` value associated with the TERMINATED_ABNORMALLY instance of this class.
`static IndexJobStatus`	`TERMINATED_NORMALLY` The indexing job completed normally.
`static int`	`TERMINATED_NORMALLY_AS_INT` An `int` value associated with the TERMINATED_NORMALLY instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static IndexJobStatus`	`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
  - CANCELED_AS_INT
```
public static final int CANCELED_AS_INT
```
    An int value associated with the CANCELED 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
  - CANCELED
```
public static final IndexJobStatus CANCELED
```
    The indexing job was canceled by an administrator.
  - TERMINATED_ABNORMALLY_AS_INT
```
public static final int TERMINATED_ABNORMALLY_AS_INT
```
    An int value associated with the TERMINATED_ABNORMALLY 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
  - TERMINATED_ABNORMALLY
```
public static final IndexJobStatus TERMINATED_ABNORMALLY
```
    The indexing job was terminated before completion due to an unexpected error.
  - ABORT_IN_PROGRESS_AS_INT
```
public static final int ABORT_IN_PROGRESS_AS_INT
```
    An int value associated with the ABORT_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
  - ABORT_IN_PROGRESS
```
public static final IndexJobStatus ABORT_IN_PROGRESS
```
    A request to cancel the indexing job has been submitted (IndexJob.set_JobAbortRequested), and the cancel operation is currently in progress.
  - TERMINATED_NORMALLY_AS_INT
```
public static final int TERMINATED_NORMALLY_AS_INT
```
    An int value associated with the TERMINATED_NORMALLY 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
  - TERMINATED_NORMALLY
```
public static final IndexJobStatus TERMINATED_NORMALLY
```
    The indexing job completed normally.
  - 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 IndexJobStatus IN_PROGRESS
```
    The indexing job 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 IndexJobStatus PAUSED
```
    A request to pause the indexing job has been submitted (IndexJob.set_JobPauseRequested) and the indexing job has been paused.
  - PENDING_AS_INT
```
public static final int PENDING_AS_INT
```
    An int value associated with the 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
  - PENDING
```
public static final IndexJobStatus PENDING
```
    The indexing job request has been submitted and is currently pending.
- 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 IndexJobStatus 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

CANCELED_AS_INT

CANCELED

TERMINATED_ABNORMALLY_AS_INT

TERMINATED_ABNORMALLY

ABORT_IN_PROGRESS_AS_INT

ABORT_IN_PROGRESS

TERMINATED_NORMALLY_AS_INT

TERMINATED_NORMALLY

IN_PROGRESS_AS_INT

IN_PROGRESS

PAUSED_AS_INT

PAUSED

PENDING_AS_INT

PENDING

getValue

toString

getInstanceFromInt