com.ibm.retail.AEF.workstation
Interface Workstation

All Superinterfaces:
java.rmi.Remote

public interface Workstation
extends java.rmi.Remote

Workstation is an interface which allows interaction with workstation devices.


Field Summary
static java.lang.String CLASS_KEY
           
static int LOCKED_POSITION
           
static int NORMAL_POSITION
           
static int PHYSICAL_POSITION
           
static int PTR_BC_CENTER
           
static int PTR_BC_LEFT
           
static int PTR_BC_RIGHT
           
static int PTR_BC_TEXT_ABOVE
           
static int PTR_BC_TEXT_BELOW
           
static int PTR_BC_TEXT_NONE
           
static int PTR_BCS_Codabar
           
static int PTR_BCS_Code128
           
static int PTR_BCS_Code39
           
static int PTR_BCS_Code93
           
static int PTR_BCS_EAN128
           
static int PTR_BCS_EAN13
           
static int PTR_BCS_EAN13_S
           
static int PTR_BCS_EAN8
           
static int PTR_BCS_EAN8_S
           
static int PTR_BCS_ITF
           
static int PTR_BCS_JAN13
           
static int PTR_BCS_JAN8
           
static int PTR_BCS_MAXICODE
           
static int PTR_BCS_OCRA
           
static int PTR_BCS_OCRB
           
static int PTR_BCS_OTHER
           
static int PTR_BCS_PDF417
           
static int PTR_BCS_TF
           
static int PTR_BCS_UPCA
           
static int PTR_BCS_UPCA_S
           
static int PTR_BCS_UPCD1
           
static int PTR_BCS_UPCD2
           
static int PTR_BCS_UPCD3
           
static int PTR_BCS_UPCD4
           
static int PTR_BCS_UPCD5
           
static int PTR_BCS_UPCE
           
static int PTR_BCS_UPCE_S
           
static int PTR_BM_ASIS
           
static int PTR_S_JOURNAL
           
static int PTR_S_RECEIPT
           
static int PTR_S_SLIP
           
static int SUPERVISOR_POSITION
           
 
Method Summary
 void addKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c)
          Add a KeyConsumer.
 void clearLineDisplay()
          Used to clear the line display device (LineDisplay1).
 void clearLineDisplay(java.lang.String displayLogicalName)
          Used to clear the line display device.
 boolean getInputDevicesLocked()
          Indicates whether input devices are allowed to provide input.
 com.ibm.retail.AEF.workstation.KeyCode getKeyCode(int rawscancode)
          Returns a logical keyboard code object from a raw keyboard scancode.
 int getKeyLockPosition()
          Gets the logical keylock position which may or may not match the physical position.
 java.lang.String getLastKeySequence()
          Returns the last key sequence which was sent to the POS application via a call to the sendKeySequence method.
 int getLogicalKeyCode(int rawscancode)
          Returns a logical keyboard code from a raw keyboard scancode.
 int getRawScanCode(int logicalcode)
          Translates a logical keyboard code to a raw keyboard scancode
 java.util.Vector getRawScanCodes(int logicalcode)
          Translates a logical keyboard code to a Vector of raw keyboard scancode
 com.ibm.retail.AEF.session.AEFSession getSession()
          Gets the AEFSession associated with this workstation.
 boolean hasPendingMessage()
          Determine if the workstation has a pending system message
 boolean isLogicalKeyCodeDoubleKey(int keycode)
          Indicates whether a logical keycode is part of a double key pair.
 boolean isRawScanCodeDoubleKey(int scancode)
          Indicates whether a raw scancode is part of a double key pair.
 java.lang.String lineDisplayPrompt(java.lang.String promptText, int row, int startCol, int endCol, int maxLen, java.lang.String doneFCode, java.lang.String clearFCode, java.lang.String cancelFCode, java.lang.String maskChar)
          Used to prompt for input on a line display device (LineDisplay1) and keyboard.
 java.lang.String lineDisplayPrompt(java.lang.String displayLogicalName, java.lang.String promptText, int row, int startCol, int endCol, int maxLen, java.lang.String doneFCode, java.lang.String clearFCode, java.lang.String cancelFCode, java.lang.String maskChar)
          Used to prompt for input on a line display device and keyboard.
 void printBarCode(int Station, java.lang.String data, int symbology, int width, int height, int alignment, int textPosition)
          Used to print a bar code on the POS printer.
 void printBitmap(int Station, java.lang.String filename, int width, int alignment)
          Used to print a bitmap on the POS printer.
 void printLine(int Station, java.lang.String data)
          Used to print a line on the POS printer.
 java.lang.String readPendingMessage()
          Reads pending system messages for the workstation.
 void removeKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c)
          Remove a KeyConsumer.
 void resendLastKeySequence()
          Resends the last key sequence which was sent to the POS application.
 void sendKeySequence(java.lang.String sequence)
          Sends a key sequence to the transaction.
 void setInputDevicesLocked(boolean locked)
          Determines whether input devices are allowed to provide input.
 void setInputPending(boolean pending)
          Used to indicate there is input coming, but not yet sent.
 void setKeyLockPosition(int position)
          Overrides the reported keylock position.
 void setLineDisplayText(java.lang.String text, int row, int col, boolean clear)
          Used to write text to the line display (LineDisplay1) device.
 void setLineDisplayText(java.lang.String displayLogicalName, java.lang.String text, int row, int col, boolean clear)
          Used to write text to the line display device.
 void setSession(com.ibm.retail.AEF.session.AEFSession session)
          Sets the AEFSession associated with this workstation.
 void swipeMSR(byte[] track1Data, byte[] track2Data, byte[] track3Data)
          Used to generate a MSR card swipe containing the specified track data.
 void swipeMSR(java.lang.String track1Data, java.lang.String track2Data, java.lang.String track3Data)
          Used to generate a MSR card swipe containing the specified track data.
 

Field Detail

CLASS_KEY

public static final java.lang.String CLASS_KEY
See Also:
Constant Field Values

PHYSICAL_POSITION

public static final int PHYSICAL_POSITION
See Also:
Constant Field Values

LOCKED_POSITION

public static final int LOCKED_POSITION
See Also:
Constant Field Values

NORMAL_POSITION

public static final int NORMAL_POSITION
See Also:
Constant Field Values

SUPERVISOR_POSITION

public static final int SUPERVISOR_POSITION
See Also:
Constant Field Values

PTR_S_JOURNAL

public static final int PTR_S_JOURNAL
See Also:
Constant Field Values

PTR_S_RECEIPT

public static final int PTR_S_RECEIPT
See Also:
Constant Field Values

PTR_S_SLIP

public static final int PTR_S_SLIP
See Also:
Constant Field Values

PTR_BCS_UPCA

public static final int PTR_BCS_UPCA
See Also:
Constant Field Values

PTR_BCS_UPCE

public static final int PTR_BCS_UPCE
See Also:
Constant Field Values

PTR_BCS_JAN8

public static final int PTR_BCS_JAN8
See Also:
Constant Field Values

PTR_BCS_EAN8

public static final int PTR_BCS_EAN8
See Also:
Constant Field Values

PTR_BCS_JAN13

public static final int PTR_BCS_JAN13
See Also:
Constant Field Values

PTR_BCS_EAN13

public static final int PTR_BCS_EAN13
See Also:
Constant Field Values

PTR_BCS_TF

public static final int PTR_BCS_TF
See Also:
Constant Field Values

PTR_BCS_ITF

public static final int PTR_BCS_ITF
See Also:
Constant Field Values

PTR_BCS_Codabar

public static final int PTR_BCS_Codabar
See Also:
Constant Field Values

PTR_BCS_Code39

public static final int PTR_BCS_Code39
See Also:
Constant Field Values

PTR_BCS_Code93

public static final int PTR_BCS_Code93
See Also:
Constant Field Values

PTR_BCS_Code128

public static final int PTR_BCS_Code128
See Also:
Constant Field Values

PTR_BCS_UPCA_S

public static final int PTR_BCS_UPCA_S
See Also:
Constant Field Values

PTR_BCS_UPCE_S

public static final int PTR_BCS_UPCE_S
See Also:
Constant Field Values

PTR_BCS_UPCD1

public static final int PTR_BCS_UPCD1
See Also:
Constant Field Values

PTR_BCS_UPCD2

public static final int PTR_BCS_UPCD2
See Also:
Constant Field Values

PTR_BCS_UPCD3

public static final int PTR_BCS_UPCD3
See Also:
Constant Field Values

PTR_BCS_UPCD4

public static final int PTR_BCS_UPCD4
See Also:
Constant Field Values

PTR_BCS_UPCD5

public static final int PTR_BCS_UPCD5
See Also:
Constant Field Values

PTR_BCS_EAN8_S

public static final int PTR_BCS_EAN8_S
See Also:
Constant Field Values

PTR_BCS_EAN13_S

public static final int PTR_BCS_EAN13_S
See Also:
Constant Field Values

PTR_BCS_EAN128

public static final int PTR_BCS_EAN128
See Also:
Constant Field Values

PTR_BCS_OCRA

public static final int PTR_BCS_OCRA
See Also:
Constant Field Values

PTR_BCS_OCRB

public static final int PTR_BCS_OCRB
See Also:
Constant Field Values

PTR_BCS_PDF417

public static final int PTR_BCS_PDF417
See Also:
Constant Field Values

PTR_BCS_MAXICODE

public static final int PTR_BCS_MAXICODE
See Also:
Constant Field Values

PTR_BCS_OTHER

public static final int PTR_BCS_OTHER
See Also:
Constant Field Values

PTR_BC_LEFT

public static final int PTR_BC_LEFT
See Also:
Constant Field Values

PTR_BC_CENTER

public static final int PTR_BC_CENTER
See Also:
Constant Field Values

PTR_BC_RIGHT

public static final int PTR_BC_RIGHT
See Also:
Constant Field Values

PTR_BC_TEXT_NONE

public static final int PTR_BC_TEXT_NONE
See Also:
Constant Field Values

PTR_BC_TEXT_ABOVE

public static final int PTR_BC_TEXT_ABOVE
See Also:
Constant Field Values

PTR_BC_TEXT_BELOW

public static final int PTR_BC_TEXT_BELOW
See Also:
Constant Field Values

PTR_BM_ASIS

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

sendKeySequence

public void sendKeySequence(java.lang.String sequence)
                     throws AEFException,
                            java.rmi.RemoteException
Sends a key sequence to the transaction. A key sequence is composed of function keys designated by <ff> where ff is the function code of the key sequence. The function code is mapped to a keyboard scancode in a system dependent fashion. The key sequence may contain raw numeric and alphabetic characters.

Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.CONFIG_ERROR, AEFConst.INVALID_KEYSEQUENCE_EXPRESSION
AEFConst.CONFIG_ERROR, AEFConst.NONNUMERIC_FUNCTIONCODE
AEFConst.SYSTEM_BUSY
AEFConst.INPUT_NOT_ALLOWED
AEFException

resendLastKeySequence

public void resendLastKeySequence()
                           throws AEFException,
                                  java.rmi.RemoteException
Resends the last key sequence which was sent to the POS application. This is typically used in a situation where there was an error that was cleared, and the key sequence needs to be retried.

Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.CONFIG_ERROR, AEFConst.INVALID_KEYSEQUENCE_EXPRESSION
AEFConst.CONFIG_ERROR, AEFConst.NONNUMERIC_FUNCTIONCODE
AEFConst.SYSTEM_BUSY
AEFConst.INPUT_NOT_ALLOWED
AEFException

getLastKeySequence

public java.lang.String getLastKeySequence()
                                    throws java.rmi.RemoteException
Returns the last key sequence which was sent to the POS application via a call to the sendKeySequence method.

Returns:
String The last key sequence sent via the sendKeySequence method.
Throws:
java.rmi.RemoteException

getKeyCode

public com.ibm.retail.AEF.workstation.KeyCode getKeyCode(int rawscancode)
                                                  throws java.rmi.RemoteException
Returns a logical keyboard code object from a raw keyboard scancode.

Returns:
keycode object for POS application
Throws:
java.rmi.RemoteException

getLogicalKeyCode

public int getLogicalKeyCode(int rawscancode)
                      throws java.rmi.RemoteException
Returns a logical keyboard code from a raw keyboard scancode.

Returns:
mapped code value for POS application (this is a function code on 4690). Returns zero if there is no keyboard, or there is no mapping for the specified scancode.
Throws:
java.rmi.RemoteException

getRawScanCode

public int getRawScanCode(int logicalcode)
                   throws java.rmi.RemoteException
Translates a logical keyboard code to a raw keyboard scancode

Returns:
scancode value for POS application, if the value is -1, there is no scancode mapping for the requested function code.
Throws:
java.rmi.RemoteException

getRawScanCodes

public java.util.Vector getRawScanCodes(int logicalcode)
                                 throws java.rmi.RemoteException
Translates a logical keyboard code to a Vector of raw keyboard scancode

Returns:
Vector of scancode values for POS application, if the value is null there is no scancode mapping for the requested function code.
Throws:
java.rmi.RemoteException

isRawScanCodeDoubleKey

public boolean isRawScanCodeDoubleKey(int scancode)
                               throws java.rmi.RemoteException
Indicates whether a raw scancode is part of a double key pair.

Parameters:
scancode - value to check.
Returns:
boolean
Throws:
java.rmi.RemoteException

isLogicalKeyCodeDoubleKey

public boolean isLogicalKeyCodeDoubleKey(int keycode)
                                  throws java.rmi.RemoteException
Indicates whether a logical keycode is part of a double key pair.

Parameters:
keycode - value to check.
Returns:
boolean
Throws:
java.rmi.RemoteException

setInputDevicesLocked

public void setInputDevicesLocked(boolean locked)
                           throws AEFException,
                                  java.rmi.RemoteException
Determines whether input devices are allowed to provide input.

Parameters:
locked - Set true to lock all input devices, false to unlock all input devices.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
AEFException

getInputDevicesLocked

public boolean getInputDevicesLocked()
                              throws AEFException,
                                     java.rmi.RemoteException
Indicates whether input devices are allowed to provide input.

Returns:
True if all input devices are locked, false otherwise.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
AEFException

lineDisplayPrompt

public java.lang.String lineDisplayPrompt(java.lang.String displayLogicalName,
                                          java.lang.String promptText,
                                          int row,
                                          int startCol,
                                          int endCol,
                                          int maxLen,
                                          java.lang.String doneFCode,
                                          java.lang.String clearFCode,
                                          java.lang.String cancelFCode,
                                          java.lang.String maskChar)
                                   throws AEFException,
                                          java.rmi.RemoteException
Used to prompt for input on a line display device and keyboard. This method will unlock input devices if they are locked.

Parameters:
displayLogicalName - The logical name of the line display which should be used to display the prompt. Should be LineDisplay1 or LineDisplay2.
promptText - The text which should be displayed on the line display device. The text will be broken into multiple lines as appropriate.
row - The row where input will be displayed (1 based index)
startCol - The starting column where input will be displayed (1 based index)
endCol - The ending column where input will be displayed (1 based index)
maxLen - The maximum length of the input.
doneFCode - The function code which indicates the input is complete. This function code is mapped to a keyboard scancode in an application specific manner.
clearFCode - The function code which clears the input field. This function code is mapped to a keyboard scancode in an application specific manner.
cancelFCode - The function code which cancels the input operation. This function code is mapped to a keyboard scancode in an application specific manner. If this function code is detected, an AEFException is thrown with an INPUT_CANCELLED error code. This value may be null if cancel is not allowed.
maskChar - An optional string containing a single character which will be used as a mask character to display instead of the actual input. This is used for entering sensitive data such as passwords. Use a null string for no masking.
Returns:
String The data as entered by the operator on the keyboard.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.INPUT_CANCELLED
AEFConst.DEVICE_HOOK_ERROR
AEFException

lineDisplayPrompt

public java.lang.String lineDisplayPrompt(java.lang.String promptText,
                                          int row,
                                          int startCol,
                                          int endCol,
                                          int maxLen,
                                          java.lang.String doneFCode,
                                          java.lang.String clearFCode,
                                          java.lang.String cancelFCode,
                                          java.lang.String maskChar)
                                   throws AEFException,
                                          java.rmi.RemoteException
Used to prompt for input on a line display device (LineDisplay1) and keyboard. This method will unlock input devices if they are locked.

Parameters:
promptText - The text which should be displayed on the line display device. The text will be broken into multiple lines as appropriate.
row - The row where input will be displayed (1 based index)
startCol - The starting column where input will be displayed (1 based index)
endCol - The ending column where input will be displayed (1 based index)
maxLen - The maximum length of the input.
doneFCode - The function code which indicates the input is complete. This function code is mapped to a keyboard scancode in an application specific manner.
clearFCode - The function code which clears the input field. This function code is mapped to a keyboard scancode in an application specific manner.
cancelFCode - The function code which cancels the input operation. This function code is mapped to a keyboard scancode in an application specific manner. If this function code is detected, an AEFException is thrown with an INPUT_CANCELLED error code. This value may be null if cancel is not allowed.
maskChar - An optional string containing a single character which will be used as a mask character to display instead of the actual input. This is used for entering sensitive data such as passwords. Use a null string for no masking.
Returns:
String The data as entered by the operator on the keyboard.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.INPUT_CANCELLED
AEFConst.DEVICE_HOOK_ERROR
AEFException

setLineDisplayText

public void setLineDisplayText(java.lang.String displayLogicalName,
                               java.lang.String text,
                               int row,
                               int col,
                               boolean clear)
                        throws AEFException,
                               java.rmi.RemoteException
Used to write text to the line display device.

Parameters:
displayLogicalName - The logical name of the line display which should be used to display the text. Should be LineDisplay1 or LineDisplay2.
text - The text which should be displayed on the line display device. The text will be broken into multiple lines as appropriate.
row - The row where input will be displayed (1 based index)
col - The starting column where input will be displayed (1 based index)
clear - boolean indicating whether the line display should be cleared prior to displaying the specified text.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.DEVICE_HOOK_ERROR
AEFException

setLineDisplayText

public void setLineDisplayText(java.lang.String text,
                               int row,
                               int col,
                               boolean clear)
                        throws AEFException,
                               java.rmi.RemoteException
Used to write text to the line display (LineDisplay1) device.

Parameters:
text - The text which should be displayed on the line display device. The text will be broken into multiple lines as appropriate.
row - The row where input will be displayed (1 based index)
col - The starting column where input will be displayed (1 based index)
clear - boolean indicating whether the line display should be cleared prior to displaying the specified text.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFException

clearLineDisplay

public void clearLineDisplay(java.lang.String displayLogicalName)
                      throws AEFException,
                             java.rmi.RemoteException
Used to clear the line display device.

Parameters:
displayLogicalName - The logical name of the line display which should be cleared. Should be LineDisplay1 or LineDisplay2.
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.DEVICE_HOOK_ERROR
AEFException

clearLineDisplay

public void clearLineDisplay()
                      throws AEFException,
                             java.rmi.RemoteException
Used to clear the line display device (LineDisplay1).

Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.DEVICE_HOOK_ERROR
AEFException

printBarCode

public void printBarCode(int Station,
                         java.lang.String data,
                         int symbology,
                         int width,
                         int height,
                         int alignment,
                         int textPosition)
                  throws java.rmi.RemoteException,
                         AEFException
Used to print a bar code on the POS printer.

Parameters:
Station - PTR_S_RECEIPT, PTR_S_SLIP
data - The bar code data
symbology - PTR_BCS_UPCA, etc.
height - Height of the barcode (defaults to dots)
width - Width of the barcode (defaults to dots)
alignment - PTR_BC_LEFT, PTR_BC_CENTER, PTR_BC_RIGHT
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.DEVICE_NOT_REDIRECTED if the printer is not redirected.
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception.

printBitmap

public void printBitmap(int Station,
                        java.lang.String filename,
                        int width,
                        int alignment)
                 throws java.rmi.RemoteException,
                        AEFException
Used to print a bitmap on the POS printer.

Parameters:
Station - PTR_S_JOURNAL, PTR_S_RECEIPT, PTR_S_SLIP
filename - The filename of the image to print
width - Width of the image (defaults to dots)
alignment - PTR_BC_LEFT, PTR_BC_CENTER, PTR_BC_RIGHT
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.DEVICE_NOT_REDIRECTED if the printer is not redirected.
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception.

printLine

public void printLine(int Station,
                      java.lang.String data)
               throws java.rmi.RemoteException,
                      AEFException
Used to print a line on the POS printer.

Parameters:
Station - PTR_S_RECEIPT, PTR_S_SLIP
data - The data to print.
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.DEVICE_NOT_REDIRECTED if the printer is not redirected.
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception.

swipeMSR

public void swipeMSR(byte[] track1Data,
                     byte[] track2Data,
                     byte[] track3Data)
              throws java.rmi.RemoteException,
                     AEFException
Used to generate a MSR card swipe containing the specified track data. Note that the track data is not validated, and will be passed to the POS application as is.

Parameters:
track1Data - A byte array containing the raw track 1 data (do not include sentinels). Byte values should fall within the range 0x00 - 0x3F. Use null or a zero length array if no track 1 data.
track2Data - A byte array containing the raw track 2 data (do not include sentinels). Byte values should fall within the range 0x00 - 0x0F. Use null or a zero length array if no track 2 data.
track3Data - A byte array containing the raw track 3 data (do not include sentinels). Byte values should fall within the range 0x00 - 0x0F. Use null or a zero length array if no track 3 data.
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_SET_TO_DECODE
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_NOT_ENABLED
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception.
AEFConst.DEVICE_NOT_REDIRECTED if the MSR is not redirected.

swipeMSR

public void swipeMSR(java.lang.String track1Data,
                     java.lang.String track2Data,
                     java.lang.String track3Data)
              throws java.rmi.RemoteException,
                     AEFException
Used to generate a MSR card swipe containing the specified track data. Note that the track data is not validated. This method is provided as a convenience so that track data can be specified using characters rather than bytes. The actual byte data will be passed to the application. To convert the track 1 data to bytes, 0x20 will be subtracted from each character to come up with the byte value. For track 2 and track 3 data, 0x30 will be subtracted from each character to come up with the byte value.

Parameters:
track1Data - A String containing the raw track 1 data (do not include sentinels). Character values should fall within the range ' ' to '_' (0x20 to 0x5F). Use null or an empty string if no track 1 data.
track2Data - A byte array containing the raw track 2 data (do not include sentinels). Character values should fall within the range '0' to '?' (0x30 to 0x3F). Use null or an empty string if no track 2 data.
track3Data - A byte array containing the raw track 3 data (do not include sentinels). Character values should fall within the range '0' - '?' (0x30 to 0x3F). Use null or an empty string if no track 3 data.
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_SET_TO_DECODE
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_NOT_ENABLED
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception.
AEFConst.DEVICE_NOT_REDIRECTED if the MSR is not redirected.

setSession

public void setSession(com.ibm.retail.AEF.session.AEFSession session)
                throws java.rmi.RemoteException,
                       AEFException
Sets the AEFSession associated with this workstation.

Parameters:
session -
Throws:
java.rmi.RemoteException
AEFException - Possible return codes are:
AEFConst.JAVA_POS_EXCEPTION

getSession

public com.ibm.retail.AEF.session.AEFSession getSession()
                                                 throws java.rmi.RemoteException
Gets the AEFSession associated with this workstation.

Returns:
AEFSession
Throws:
java.rmi.RemoteException

setKeyLockPosition

public void setKeyLockPosition(int position)
                        throws java.rmi.RemoteException,
                               AEFException
Overrides the reported keylock position. This method is used when the AEF is in automatic mode with automatic manager override to set the keylock position to the desired position. This method will cause the application to think that the keylock is in the requested position. This applies to simulated or physical keylock devices.

Parameters:
position - Must be either LOCKED_POSITION, NORMAL_POSITION, SUPERVISOR_POSITION, PHYSICAL_POSITION
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.INVALID_ARGUMENT
AEFConst.JAVA_POS_EXCEPTION
AEFConst.DEVICE_HOOK_ERROR
AEFException

getKeyLockPosition

public int getKeyLockPosition()
                       throws java.rmi.RemoteException,
                              AEFException
Gets the logical keylock position which may or may not match the physical position. This applies to simulated or physical keylock devices.

Returns:
int Must be either LOCKED_POSITION, NORMAL_POSITION, SUPERVISOR_POSITION, PHYSICAL_POSITION
Throws:
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException - Possible return codes are:
AEFConst.JAVA_POS_EXCEPTION
AEFConst.DEVICE_HOOK_ERROR
AEFException

readPendingMessage

public java.lang.String readPendingMessage()
                                    throws java.rmi.RemoteException
Reads pending system messages for the workstation.

Returns:
String text of the message (null if no messages)
Throws:
java.rmi.RemoteException

hasPendingMessage

public boolean hasPendingMessage()
                          throws java.rmi.RemoteException
Determine if the workstation has a pending system message

Returns:
true if the workstation has a pending system message
Throws:
java.rmi.RemoteException

addKeyConsumer

public void addKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c)
                    throws java.rmi.RemoteException
Add a KeyConsumer. KeyConsumers receive synchronous notification for each keyboard event generated and can elect to consume the event.

Throws:
java.rmi.RemoteException
See Also:
KeyConsumer

removeKeyConsumer

public void removeKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c)
                       throws java.rmi.RemoteException
Remove a KeyConsumer. KeyConsumers receive synchronous notification for each keyboard event generated and can elect to consume the event.

Throws:
java.rmi.RemoteException
See Also:
KeyConsumer

setInputPending

public void setInputPending(boolean pending)
                     throws java.rmi.RemoteException
Used to indicate there is input coming, but not yet sent. Used by the GUI during input (such as quantity input) so that an error will be generated if a scan is done while there is input pending.

Throws:
java.rmi.RemoteException


Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004