|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.IndexJobStatus
public final class IndexJobStatus
Identifies the current status of an indexing job.
If an index job terminates abnormally for any reason, indexing data for some objects will be in two collections if either a base class or a collection is indexed. The index job for this collection or class should be resubmitted after the cause of the abnormal termination is corrected.
Note: When an index job is aborted and either the index job does not include all subclasses of a base class, or the index job was for single item indexes, no duplicate index items exist because these types of index jobs perform individual object deletes from the collection (rather than deleting the entire collection at the end of a successfully completed index job).
IndexJob
,
Serialized FormField Summary | |
---|---|
static IndexJobStatus |
ABORT_IN_PROGRESS
A request to abort the indexing job has been submitted ( IndexJob.setJobAbortRequested ), and the abort 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 |
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 |
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. |
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 | |
---|---|
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 |
---|
public static final int TERMINATED_ABNORMALLY_AS_INT
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.
public static final IndexJobStatus TERMINATED_ABNORMALLY
public static final int ABORT_IN_PROGRESS_AS_INT
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.
public static final IndexJobStatus ABORT_IN_PROGRESS
IndexJob.setJobAbortRequested
), and the abort operation
is currently in progress.
public static final int TERMINATED_NORMALLY_AS_INT
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.
public static final IndexJobStatus TERMINATED_NORMALLY
public static final int IN_PROGRESS_AS_INT
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.
public static final IndexJobStatus IN_PROGRESS
public static final int PENDING_AS_INT
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.
public static final IndexJobStatus PENDING
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 IndexJobStatus 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 |