com.symbol.emdk.personalshopper

Enum CradleResults

java.lang.Object

java.lang.Enum<CradleResults>

com.symbol.emdk.personalshopper.CradleResults

All Implemented Interfaces:

Serializable, Comparable<CradleResults>

public enum CradleResults
extends Enum<CradleResults>

Defines all the error codes the cradle API returns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_DISABLED Already disabled.
ALREADY_ENABLED Already enabled.
ALREADY_IN_USE Already in use
ALREADY_UNLOCKED Already unlocked.
FAILURE Failure
FEATURE_NOT_SUPPORTED Feature not supported.
INVALID_OBJECT Invalid Object
INVALID_VALUE Invalid value
NOT_ENABLED Not enabled
SUCCESS Success.
UNDEFINED Error code not defined.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description for the error.
int	getValue() This method provides integer value assigned to the enum.
static CradleResults	valueOf(String name) Returns the enum constant of this type with the specified name.
static CradleResults[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final CradleResults SUCCESS

Success.

FAILURE

public static final CradleResults FAILURE

Failure

ALREADY_ENABLED

public static final CradleResults ALREADY_ENABLED

Already enabled.

ALREADY_UNLOCKED

public static final CradleResults ALREADY_UNLOCKED

Already unlocked.

ALREADY_DISABLED

public static final CradleResults ALREADY_DISABLED

Already disabled.

ALREADY_IN_USE

public static final CradleResults ALREADY_IN_USE

Already in use

FEATURE_NOT_SUPPORTED

public static final CradleResults FEATURE_NOT_SUPPORTED

Feature not supported.

INVALID_VALUE

public static final CradleResults INVALID_VALUE

Invalid value

NOT_ENABLED

public static final CradleResults NOT_ENABLED

Not enabled

INVALID_OBJECT

public static final CradleResults INVALID_OBJECT

Invalid Object

UNDEFINED

public static final CradleResults UNDEFINED

Error code not defined.

Method Detail

values

public static CradleResults[] 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 (CradleResults c : CradleResults.values())
    System.out.println(c);

Returns:

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

valueOf

public static CradleResults 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

getValue

public int getValue()

This method provides integer value assigned to the enum. It is recommended only to get error for the UNDEFINED enums at runtime if required.

Returns:

Return error code integer value

getDescription

public String getDescription()

Returns the description for the error.

Returns:

Returns error description.