com.symbol.emdk.barcode

Enum ScannerResults

java.lang.Object

java.lang.Enum<ScannerResults>

com.symbol.emdk.barcode.ScannerResults

All Implemented Interfaces:

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

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

Defines all the error codes the barcode scanning API returns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_SCANNING Scanning in progress.
DATA_PARSING_FAILURE Data parsing failed.
FAILURE Failure
FEATURE_NOT_SUPPORTED The feature is not supported.
INVALID_OBJECT The object is not valid.
INVALID_VALUE The value is invalid.
LENGTH_MISMATCH Decoded barcode does not meet length requirements.
NO_DATA_LISTENER Scan read is issued without adding the data listener.
SCAN_DATA_FAILURE Unexpected scan data
SCAN_PARAM_NOT_SUPPORTED Particular parameter not supported.
SCAN_PARAM_READ_ONLY Read only parameters.
SCANNER_DEINIT_FAILURE Scanner de-initialization failed.
SCANNER_IN_USE Cannot enable scanner and is already in use.
SCANNER_INIT_FAILURE Scanner initialization failed.
SCANNER_NOT_CONNECTED The scanner device is not connected.
SCANNER_NOT_ENABLED The scanner device is not enabled.
SCANNER_NOT_SUPPORTED Scanner not supported.
SCANNER_OPERATION_FAILURE Scanner operation failed.
SCANNER_TIMED_OUT The timer out error occurred.
SUCCESS Success.
TRIGGER_KEY_IN_USE Trigger key is already used by other user.
TRIGGER_KEY_REG_FAILED Failed to register for the hard trigger key notification.
TRIGGER_KEY_UNREG_FAILED Failed to unRegister for the hard trigger key notification.
UNDEFINED Error code not defined.
VF_ERROR View finder error.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description for the error.
int	getValue() This method provides integer value assigned to the enum.
static ScannerResults	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ScannerResults[]	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 ScannerResults SUCCESS

Success.

ALREADY_SCANNING

public static final ScannerResults ALREADY_SCANNING

Scanning in progress.

SCANNER_IN_USE

public static final ScannerResults SCANNER_IN_USE

Cannot enable scanner and is already in use.

VF_ERROR

public static final ScannerResults VF_ERROR

View finder error.

INVALID_VALUE

public static final ScannerResults INVALID_VALUE

The value is invalid.

SCAN_PARAM_NOT_SUPPORTED

public static final ScannerResults SCAN_PARAM_NOT_SUPPORTED

Particular parameter not supported.

SCAN_DATA_FAILURE

public static final ScannerResults SCAN_DATA_FAILURE

Unexpected scan data

SCAN_PARAM_READ_ONLY

public static final ScannerResults SCAN_PARAM_READ_ONLY

Read only parameters.

LENGTH_MISMATCH

public static final ScannerResults LENGTH_MISMATCH

Decoded barcode does not meet length requirements.

SCANNER_OPERATION_FAILURE

public static final ScannerResults SCANNER_OPERATION_FAILURE

Scanner operation failed.

FEATURE_NOT_SUPPORTED

public static final ScannerResults FEATURE_NOT_SUPPORTED

The feature is not supported.

SCANNER_NOT_SUPPORTED

public static final ScannerResults SCANNER_NOT_SUPPORTED

Scanner not supported.

FAILURE

public static final ScannerResults FAILURE

Failure

SCANNER_NOT_ENABLED

public static final ScannerResults SCANNER_NOT_ENABLED

The scanner device is not enabled.

SCANNER_NOT_CONNECTED

public static final ScannerResults SCANNER_NOT_CONNECTED

The scanner device is not connected.

SCANNER_TIMED_OUT

public static final ScannerResults SCANNER_TIMED_OUT

The timer out error occurred.

INVALID_OBJECT

public static final ScannerResults INVALID_OBJECT

The object is not valid.

NO_DATA_LISTENER

public static final ScannerResults NO_DATA_LISTENER

Scan read is issued without adding the data listener.

TRIGGER_KEY_REG_FAILED

public static final ScannerResults TRIGGER_KEY_REG_FAILED

Failed to register for the hard trigger key notification.

TRIGGER_KEY_IN_USE

public static final ScannerResults TRIGGER_KEY_IN_USE

Trigger key is already used by other user.

TRIGGER_KEY_UNREG_FAILED

public static final ScannerResults TRIGGER_KEY_UNREG_FAILED

Failed to unRegister for the hard trigger key notification.

SCANNER_INIT_FAILURE

public static final ScannerResults SCANNER_INIT_FAILURE

Scanner initialization failed.

SCANNER_DEINIT_FAILURE

public static final ScannerResults SCANNER_DEINIT_FAILURE

Scanner de-initialization failed.

DATA_PARSING_FAILURE

public static final ScannerResults DATA_PARSING_FAILURE

Data parsing failed.

UNDEFINED

public static final ScannerResults UNDEFINED

Error code not defined.

Method Detail

values

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

Returns:

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

valueOf

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

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:

getDescription

public java.lang.String getDescription()

Returns the description for the error.

Returns:

Returns error description.