Package com.appliedolap.essbase

Enum Class EssJob.Status

java.lang.Object

java.lang.Enum<EssJob.Status>

com.appliedolap.essbase.EssJob.Status

All Implemented Interfaces:

Serializable, Comparable<EssJob.Status>, Constable

Enclosing interface:

EssJob

public static enum EssJob.Status
extends Enum<EssJob.Status>

Models the status of a job. This enum may move inside the EssJob object in the future.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETED
COMPLETED_WITH_WARNINGS
FAILED
IN_PROGRESS	Represented in the Essbase REST API with code 100.
UNKNOWN	This is not an official code, we're just using it as a buffer against changes in the API

Method Summary

Modifier and Type	Method	Description
static EssJob.Status	fromCode(int code)
int	getCode()
boolean	isComplete()
boolean	isSuccessful()
static EssJob.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EssJob.Status[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IN_PROGRESS

public static final EssJob.Status IN_PROGRESS

Represented in the Essbase REST API with code 100.

COMPLETED

public static final EssJob.Status COMPLETED

COMPLETED_WITH_WARNINGS

public static final EssJob.Status COMPLETED_WITH_WARNINGS

FAILED

public static final EssJob.Status FAILED

UNKNOWN

public static final EssJob.Status UNKNOWN

This is not an official code, we're just using it as a buffer against changes in the API

Method Details

values

public static EssJob.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EssJob.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

fromCode

public static EssJob.Status fromCode(int code)

isComplete

public boolean isComplete()

isSuccessful

public boolean isSuccessful()