public final class IndexJobStatus
extends java.lang.Object
implements java.io.Serializable
IndexJob
object to identify the status of an index job.IndexJob
,
Serialized FormModifier 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. |
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. |
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 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 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
public static final int PAUSED_AS_INT
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.public static final IndexJobStatus PAUSED
IndexJob.set_JobPauseRequested
) and the indexing job has been paused.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 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.set_JobAbortRequested
), and the cancel operation
is currently in progress.public static final int CANCELED_AS_INT
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.public static final IndexJobStatus CANCELED
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()
© Copyright IBM Corporation 2006, 2015. All rights reserved.