com.sap.ip.me.api.pios.scanner
Class ScannerException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.sap.ip.me.api.services.MEException
              extended bycom.sap.ip.me.api.pios.PIOSException
                  extended bycom.sap.ip.me.api.pios.scanner.ScannerException
All Implemented Interfaces:
java.io.Serializable

public class ScannerException
extends PIOSException

An exception thrown when an error occurs during scanner operation.

Since:
MI 2.5
Author:
Abaco
See Also:
PIOSException, Serialized Form

Field Summary
static int SCANNER_CLOSE_FAILED
          Constant to indicate that scanner close failed.
static int SCANNER_END_READ_FAILED
          Constant to indicate that scanner cancel read request failed.
static int SCANNER_EVENT_LISTENER_NOT_SPECIFIED
          Constant to indicate that an event listener must be specified before calling the startRead method.
static int SCANNER_GET_SOFTTRIGGER_FAILED
          Constant to indicate that scanner soft trigger state could not be obtained.
static int SCANNER_IN_READ_MODE
          Constant to indicate that a successful endRead call must occur before performing the desired operation.
static int SCANNER_INVALID_CONFIGURATION_FILE
          Constant to indicate invalid scanner configuration file.
static int SCANNER_NOT_IN_READ_MODE
          Constant to indicate that a successful startRead call must occur before performing the desired operation.
static int SCANNER_OPEN_FAILED
          Constant to indicate that scanner open failed.
static int SCANNER_OPERATION_NOT_AVAILABLE_IN_WEDGE_MODE
          Constant to indicate error while performing an operation that is not supported in wedge mode.
static int SCANNER_SET_SOFTTRIGGER_FAILED
          Constant to indicate that scanner soft trigger state could not be set.
static int SCANNER_START_READ_FAILED
          Constant to indicate that scanner read request failed.
static int SCANNER_UNABLE_TO_ADD_SYMBOLOGY
          Constant to indicate error while adding a symbology.
static int SCANNER_UNABLE_TO_CONFIGURE
          Constant to indicate invalid scanner configuration failure.
static int SCANNER_UNABLE_TO_CONFIGURE_SYMBOLOGY
          Constant to indicate invalid scanner failure while configuring a symbology.
static int SCANNER_UNABLE_TO_REMOVE_SYMBOLOGY
          Constant to indicate error while removing a symbology.
static int SCANNER_UNKNOWN_ERROR
          Constant to indicate a scanner unknown error.
static int SCANNER_UNSUPPORTED_SYMBOLOGY
          Constant to indicate an unsupported scanner symbology.
 
Fields inherited from class com.sap.ip.me.api.pios.PIOSException
ALREADY_CREATED, ALREADY_OPENED, CONFIGURATION_ERROR, GENERIC_ERROR, INVALID_OBJECT, INVALID_PARAMETER, INVALID_SYMBOLOGY, LIBRARY_NOT_LOADED, NOT_CREATED, NOT_OPENED, OUT_OF_MEMORY, SPECIFIC_PRINTER_ERROR, SPECIFIC_RFID_ERROR, SPECIFIC_SCANNER_ERROR, TIMEOUT, UNKNOWN_ERROR, UNSPECIFIED_ERROR, UNSUPPORTED
 
Constructor Summary
ScannerException(int errorCode, java.lang.String message)
          Constructs a new ScannerException with the specified message.
ScannerException(int errorCode, java.lang.Throwable cause)
          Constructs a new ScannerException with the specified error code and cause.
ScannerException(java.lang.String message)
          Constructs a new ScannerException with the specified message.
ScannerException(java.lang.Throwable cause)
          Constructs a new ScannerException based on the stack trace of the thrown exception.
 
Methods inherited from class com.sap.ip.me.api.pios.PIOSException
getErrorCode, getException
 
Methods inherited from class com.sap.ip.me.api.services.MEException
getNestedException, getReason, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SCANNER_OPEN_FAILED

public static final int SCANNER_OPEN_FAILED
Constant to indicate that scanner open failed.

See Also:
Constant Field Values

SCANNER_CLOSE_FAILED

public static final int SCANNER_CLOSE_FAILED
Constant to indicate that scanner close failed.

See Also:
Constant Field Values

SCANNER_GET_SOFTTRIGGER_FAILED

public static final int SCANNER_GET_SOFTTRIGGER_FAILED
Constant to indicate that scanner soft trigger state could not be obtained.

See Also:
Constant Field Values

SCANNER_SET_SOFTTRIGGER_FAILED

public static final int SCANNER_SET_SOFTTRIGGER_FAILED
Constant to indicate that scanner soft trigger state could not be set.

See Also:
Constant Field Values

SCANNER_START_READ_FAILED

public static final int SCANNER_START_READ_FAILED
Constant to indicate that scanner read request failed.

See Also:
Constant Field Values

SCANNER_END_READ_FAILED

public static final int SCANNER_END_READ_FAILED
Constant to indicate that scanner cancel read request failed.

See Also:
Constant Field Values

SCANNER_UNABLE_TO_CONFIGURE

public static final int SCANNER_UNABLE_TO_CONFIGURE
Constant to indicate invalid scanner configuration failure.

See Also:
Constant Field Values

SCANNER_UNABLE_TO_CONFIGURE_SYMBOLOGY

public static final int SCANNER_UNABLE_TO_CONFIGURE_SYMBOLOGY
Constant to indicate invalid scanner failure while configuring a symbology.

See Also:
Constant Field Values

SCANNER_INVALID_CONFIGURATION_FILE

public static final int SCANNER_INVALID_CONFIGURATION_FILE
Constant to indicate invalid scanner configuration file.

See Also:
Constant Field Values

SCANNER_UNSUPPORTED_SYMBOLOGY

public static final int SCANNER_UNSUPPORTED_SYMBOLOGY
Constant to indicate an unsupported scanner symbology.

See Also:
Constant Field Values

SCANNER_UNKNOWN_ERROR

public static final int SCANNER_UNKNOWN_ERROR
Constant to indicate a scanner unknown error.

See Also:
Constant Field Values

SCANNER_NOT_IN_READ_MODE

public static final int SCANNER_NOT_IN_READ_MODE
Constant to indicate that a successful startRead call must occur before performing the desired operation.

See Also:
Constant Field Values

SCANNER_IN_READ_MODE

public static final int SCANNER_IN_READ_MODE
Constant to indicate that a successful endRead call must occur before performing the desired operation.

See Also:
Constant Field Values

SCANNER_UNABLE_TO_ADD_SYMBOLOGY

public static final int SCANNER_UNABLE_TO_ADD_SYMBOLOGY
Constant to indicate error while adding a symbology.

See Also:
Constant Field Values

SCANNER_UNABLE_TO_REMOVE_SYMBOLOGY

public static final int SCANNER_UNABLE_TO_REMOVE_SYMBOLOGY
Constant to indicate error while removing a symbology.

See Also:
Constant Field Values

SCANNER_OPERATION_NOT_AVAILABLE_IN_WEDGE_MODE

public static final int SCANNER_OPERATION_NOT_AVAILABLE_IN_WEDGE_MODE
Constant to indicate error while performing an operation that is not supported in wedge mode.

See Also:
Constant Field Values

SCANNER_EVENT_LISTENER_NOT_SPECIFIED

public static final int SCANNER_EVENT_LISTENER_NOT_SPECIFIED
Constant to indicate that an event listener must be specified before calling the startRead method.

See Also:
Constant Field Values
Constructor Detail

ScannerException

public ScannerException(java.lang.String message)
Constructs a new ScannerException with the specified message.

Parameters:
message - the exception message

ScannerException

public ScannerException(int errorCode,
                        java.lang.String message)
Constructs a new ScannerException with the specified message.

Parameters:
errorCode - the error code number
message - the exception message

ScannerException

public ScannerException(java.lang.Throwable cause)
Constructs a new ScannerException based on the stack trace of the thrown exception.

Parameters:
cause - the exception cause
See Also:
PIOSException.getException(java.lang.Throwable)

ScannerException

public ScannerException(int errorCode,
                        java.lang.Throwable cause)
Constructs a new ScannerException with the specified error code and cause.

Parameters:
errorCode - the error code number
cause - the exception cause


Copyright © 2005 SAP AG. All Rights Reserved.