com.symbol.emdk.sam

Enum SAMResults

java.lang.Object

java.lang.Enum<SAMResults>

com.symbol.emdk.sam.SAMResults

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SAMResults>

public enum SAMResults
extends java.lang.Enum<SAMResults>

Defines all the error codes that the SAM API returns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_IN_USE_BY_A_DIFFERENT_USER SAM is already in use by a different application
ANOTHER_SAM_ALREADY_IN_USE Another SAM is already in use, please disconnect from previous SAM before connecting to the new SAM.
FAILED_TO_CONNECT Failed to connect to the SAM
FAILURE Failure
INVALID_APDU_COMMAND Invalid APDU Command
SAM_ALREADY_CONNECTED Already connected to the SAM
SAM_NOT_CONNECTED SAM not connected
SAM_NOT_INITIALIZED SAM not initialized
SUCCESS Success
TRANSCEIVE_FAILURE Transceive Failure
UNDEFINED Error code not defined.
UNLICENSED_FEATURE Unlicensed feature.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getErrorDescription(SAMResults errorCode) Returns the description for the error code specified.
int	getVal()
static SAMResults	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SAMResults[]	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

FAILURE

public static final SAMResults FAILURE

Failure

SUCCESS

public static final SAMResults SUCCESS

Success

FAILED_TO_CONNECT

public static final SAMResults FAILED_TO_CONNECT

Failed to connect to the SAM

SAM_NOT_INITIALIZED

public static final SAMResults SAM_NOT_INITIALIZED

SAM not initialized

TRANSCEIVE_FAILURE

public static final SAMResults TRANSCEIVE_FAILURE

Transceive Failure

INVALID_APDU_COMMAND

public static final SAMResults INVALID_APDU_COMMAND

Invalid APDU Command

SAM_NOT_CONNECTED

public static final SAMResults SAM_NOT_CONNECTED

SAM not connected

ANOTHER_SAM_ALREADY_IN_USE

public static final SAMResults ANOTHER_SAM_ALREADY_IN_USE

Another SAM is already in use, please disconnect from previous SAM before connecting to the new SAM.

ALREADY_IN_USE_BY_A_DIFFERENT_USER

public static final SAMResults ALREADY_IN_USE_BY_A_DIFFERENT_USER

SAM is already in use by a different application

SAM_ALREADY_CONNECTED

public static final SAMResults SAM_ALREADY_CONNECTED

Already connected to the SAM

UNLICENSED_FEATURE

public static final SAMResults UNLICENSED_FEATURE

Unlicensed feature.

UNDEFINED

public static final SAMResults UNDEFINED

Error code not defined.

Method Detail

values

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

Returns:

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

valueOf

public static SAMResults valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getVal

public int getVal()

getErrorDescription

public static java.lang.String getErrorDescription(SAMResults errorCode)

Returns the description for the error code specified.

Parameters:

errorCode - SAMResults

Returns:

Returns error description.