Interface scanner_config


public interface scanner_config

scanner_config.js defines the interface the scanner device configuration.


Field Summary
static int CHECK_DIGIT_CODE39
          Transmission of CODE39 check digit
static int CHECK_DIGIT_ITF
          Transmission of ITF check digit
static int CHECK_DIGIT_NONE
          Disable transmission of all check digits
static int CHECK_DIGIT_UPCA
          Transmission of UPC-A check digit
static int CHECK_DIGIT_UPCE
          Transmission of UPC-E check digit
static int CONFIG_SYMBOLOGY_CODABAR
          Coabar symbology
static int CONFIG_SYMBOLOGY_CODE128
          Code 128 symbology
static int CONFIG_SYMBOLOGY_CODE39
          Code 39 symbology
static int CONFIG_SYMBOLOGY_CODE93
          Code 93 symbology
static int CONFIG_SYMBOLOGY_ITF
          Interleaved 2 of 5
static int CONFIG_SYMBOLOGY_STD2OF5
          Standard 2 of 5
static int CONFIG_SYMBOLOGY_UCC_EAN128
          UCC EAN128 symbology
static int CONFIG_SYMBOLOGY_UPC_EAN
          UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13
static int CONFIG_SYMBOLOGY_UPCD
          UPC-D1, UPC-D2, UPC-D3, UPC-D4, UPC-D5
static int EXPANSION_NONE
           
static int EXPANSION_UPCA_TO_EAN13
           
static int EXPANSION_UPCE_TO_EAN13
           
static int EXPANSION_UPCE_TO_UPCA
           
static int PRICE_CHECK_4_DIGIT
          Enable 4-digit price verification
static int PRICE_CHECK_5_DIGIT
          Enable 5 digiti price verification
static int PRICE_CHECK_NONE
          Disable price check verification
static int SUPPLEMENTALS_2_DIGIT
          Two-digit supplementals (+2)
static int SUPPLEMENTALS_5_DIGIT
          Five-digit supplementals (+2)
static int SUPPLEMENTALS_CODE128
          Code 128 supplementals
static int SUPPLEMENTALS_NONE
          Supplementals disabled
 
Method Summary
 boolean applyScannerConfigChanges()
          Applies all changes made to the scanner symbology.
 boolean setCheckDigits(int checkDigits)
          Configures the scanner check digits.
 boolean setHandsFreeEnable(boolean enable)
          Enables or disables the scanner's hands-free operating mode
 boolean setPriceVerification(int priceCheck)
          Configures the scanner price check functionality.
 boolean setSupplementals(int supplementals)
          Configures the scanner supplemental settings.
 boolean setSymbologies(int symbologies, int ITFLength1, int ITFLength2, int ITFLengthType)
          Configures the scanner symbologies.
 boolean setUPCExpansion(int UPCExpansion)
          Changes the symbology expansion parameters for the scanner.
 

Field Detail

CONFIG_SYMBOLOGY_UPC_EAN

public static final int CONFIG_SYMBOLOGY_UPC_EAN
UPC-A, UPC-E, EAN/JAN-8, EAN/JAN-13

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_CODABAR

public static final int CONFIG_SYMBOLOGY_CODABAR
Coabar symbology

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_UPCD

public static final int CONFIG_SYMBOLOGY_UPCD
UPC-D1, UPC-D2, UPC-D3, UPC-D4, UPC-D5

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_CODE39

public static final int CONFIG_SYMBOLOGY_CODE39
Code 39 symbology

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_CODE93

public static final int CONFIG_SYMBOLOGY_CODE93
Code 93 symbology

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_CODE128

public static final int CONFIG_SYMBOLOGY_CODE128
Code 128 symbology

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_ITF

public static final int CONFIG_SYMBOLOGY_ITF
Interleaved 2 of 5

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_STD2OF5

public static final int CONFIG_SYMBOLOGY_STD2OF5
Standard 2 of 5

See Also:
Constant Field Values

CONFIG_SYMBOLOGY_UCC_EAN128

public static final int CONFIG_SYMBOLOGY_UCC_EAN128
UCC EAN128 symbology

See Also:
Constant Field Values

CHECK_DIGIT_NONE

public static final int CHECK_DIGIT_NONE
Disable transmission of all check digits

See Also:
Constant Field Values

CHECK_DIGIT_UPCE

public static final int CHECK_DIGIT_UPCE
Transmission of UPC-E check digit

See Also:
Constant Field Values

CHECK_DIGIT_UPCA

public static final int CHECK_DIGIT_UPCA
Transmission of UPC-A check digit

See Also:
Constant Field Values

CHECK_DIGIT_ITF

public static final int CHECK_DIGIT_ITF
Transmission of ITF check digit

See Also:
Constant Field Values

CHECK_DIGIT_CODE39

public static final int CHECK_DIGIT_CODE39
Transmission of CODE39 check digit

See Also:
Constant Field Values

SUPPLEMENTALS_NONE

public static final int SUPPLEMENTALS_NONE
Supplementals disabled

See Also:
Constant Field Values

SUPPLEMENTALS_2_DIGIT

public static final int SUPPLEMENTALS_2_DIGIT
Two-digit supplementals (+2)

See Also:
Constant Field Values

SUPPLEMENTALS_5_DIGIT

public static final int SUPPLEMENTALS_5_DIGIT
Five-digit supplementals (+2)

See Also:
Constant Field Values

SUPPLEMENTALS_CODE128

public static final int SUPPLEMENTALS_CODE128
Code 128 supplementals

See Also:
Constant Field Values

PRICE_CHECK_NONE

public static final int PRICE_CHECK_NONE
Disable price check verification

See Also:
Constant Field Values

PRICE_CHECK_4_DIGIT

public static final int PRICE_CHECK_4_DIGIT
Enable 4-digit price verification

See Also:
Constant Field Values

PRICE_CHECK_5_DIGIT

public static final int PRICE_CHECK_5_DIGIT
Enable 5 digiti price verification

See Also:
Constant Field Values

EXPANSION_NONE

public static final int EXPANSION_NONE
See Also:
Constant Field Values

EXPANSION_UPCE_TO_UPCA

public static final int EXPANSION_UPCE_TO_UPCA
See Also:
Constant Field Values

EXPANSION_UPCE_TO_EAN13

public static final int EXPANSION_UPCE_TO_EAN13
See Also:
Constant Field Values

EXPANSION_UPCA_TO_EAN13

public static final int EXPANSION_UPCA_TO_EAN13
See Also:
Constant Field Values
Method Detail

setSymbologies

public boolean setSymbologies(int symbologies,
                              int ITFLength1,
                              int ITFLength2,
                              int ITFLengthType)
Configures the scanner symbologies. The changes do not take effect until they are applied.

Parameters:
symbologies - A bitwise ORing of the CONFIG_SYMBOLOGY constants to enable
ITFLength1 - Length specification for Interleaved 2 of 5 (ITF) bar codes. Requires an even number between 4 and 32 (inclusive). Only needed if ITF symbology is enabled.
ITFLength2 - Length specification for Interleaved 2 of 5 barcodes. Requires an even number between 4 and 32 (inclusive) or 0 (no second length specified). Only needed if ITF symbology is enabled.
ITFLengthType - Specifies the ITF length information type. 0: discrete length(s) specified. 1: given lengths specify a range (length2 must be non-zero). Only needed if ITF symbology is enabled.
Returns:
Returns whether the operation was successful.
See Also:
CONFIG_SYMBOLOGY_ITF, CONFIG_SYMBOLOGY_UPC_EAN, CONFIG_SYMBOLOGY_CODABAR, CONFIG_SYMBOLOGY_CODE128, CONFIG_SYMBOLOGY_CODE39, CONFIG_SYMBOLOGY_CODE93, CONFIG_SYMBOLOGY_STD2OF5, CONFIG_SYMBOLOGY_UPCD, applyScannerConfigChanges()
WATA Integration
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet

setCheckDigits

public boolean setCheckDigits(int checkDigits)
Configures the scanner check digits. The changes do not take effect until they are applied.

Parameters:
checkDigits - A bitwise ORing of the CHECK_DIGIT constants to enable
Returns:
Returns whether the operation was successful.
See Also:
CHECK_DIGIT_NONE, CHECK_DIGIT_UPCA, CHECK_DIGIT_UPCE, CHECK_DIGIT_ITF, CHECK_DIGIT_CODE39, applyScannerConfigChanges()
WATA Integration
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet

setSupplementals

public boolean setSupplementals(int supplementals)
Configures the scanner supplemental settings. The changes do not take effect until they are applied.

Parameters:
supplementals - A bitwise ORing of the SUPPLEMENTS contants to enable
Returns:
Returns whether the operation was successful.
See Also:
SUPPLEMENTALS_NONE, SUPPLEMENTALS_2_DIGIT, SUPPLEMENTALS_5_DIGIT, SUPPLEMENTALS_CODE128, applyScannerConfigChanges()
WATA Integration
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet

setPriceVerification

public boolean setPriceVerification(int priceCheck)
Configures the scanner price check functionality. The changes do not take effect until after they are applied.

Parameters:
priceCheck - The PRICE_CHECK constant to enable
Returns:
Returns whether the operation was successful.
See Also:
PRICE_CHECK_NONE, PRICE_CHECK_4_DIGIT, PRICE_CHECK_5_DIGIT, applyScannerConfigChanges()
WATA Integration
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet

setUPCExpansion

public boolean setUPCExpansion(int UPCExpansion)
Changes the symbology expansion parameters for the scanner. The changes do not take effect until after they are applied.

Parameters:
UPCExpansion - The EXPANSION constant to enable
Returns:
Returns whether the operation was successful.
See Also:
EXPANSION_NONE, EXPANSION_UPCE_TO_UPCA, EXPANSION_UPCE_TO_EAN13, EXPANSION_UPCA_TO_EAN13, applyScannerConfigChanges()
WATA Integration
Host ApplicationJavaPOSHostApplication
Host AppletJavaPOSHostApplet

setHandsFreeEnable

public boolean setHandsFreeEnable(boolean enable)
Enables or disables the scanner's hands-free operating mode

Parameters:
enable - Whether to enable or disable hands-free mode
Returns:
Returns wether the operation was successful

applyScannerConfigChanges

public boolean applyScannerConfigChanges()
Applies all changes made to the scanner symbology.