com.ibm.optim.oaas.client.job.model

Enum JobInterruptionStatus

java.lang.Object

java.lang.Enum<JobInterruptionStatus>

com.ibm.optim.oaas.client.job.model.JobInterruptionStatus

All Implemented Interfaces:

Serializable, Comparable<JobInterruptionStatus>

public enum JobInterruptionStatus
extends Enum<JobInterruptionStatus>

Enumeration describing the interruption status of executing a job.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILL The job process was stopped in the quickest possible manner manually (by a user or administrator).
OUT_OF_MEMORY The job was stopped because the job process reached the maximum allowed memory usage, as defined in the subscription.
STOP The job was interrupted using a manual call (by a user or administrator).
TIMEOUT The job processing was stopped because the timeout limit was reached.

Method Summary

Methods

Modifier and Type	Method and Description
static JobInterruptionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static JobInterruptionStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STOP

public static final JobInterruptionStatus STOP

The job was interrupted using a manual call (by a user or administrator).

KILL

public static final JobInterruptionStatus KILL

The job process was stopped in the quickest possible manner manually (by a user or administrator).

TIMEOUT

public static final JobInterruptionStatus TIMEOUT

The job processing was stopped because the timeout limit was reached. The limit is either explicitly set by a user or is taken from the default timeout value defined in the subscription.

OUT_OF_MEMORY

public static final JobInterruptionStatus OUT_OF_MEMORY

The job was stopped because the job process reached the maximum allowed memory usage, as defined in the subscription.

Method Detail

values

public static JobInterruptionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JobInterruptionStatus c : JobInterruptionStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobInterruptionStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null