|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Workstation is an interface which allows interaction with workstation devices.
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 |
public static final java.lang.String CLASS_KEY
public static final int PHYSICAL_POSITION
public static final int LOCKED_POSITION
public static final int NORMAL_POSITION
public static final int SUPERVISOR_POSITION
public static final int PTR_S_JOURNAL
public static final int PTR_S_RECEIPT
public static final int PTR_S_SLIP
public static final int PTR_BCS_UPCA
public static final int PTR_BCS_UPCE
public static final int PTR_BCS_JAN8
public static final int PTR_BCS_EAN8
public static final int PTR_BCS_JAN13
public static final int PTR_BCS_EAN13
public static final int PTR_BCS_TF
public static final int PTR_BCS_ITF
public static final int PTR_BCS_Codabar
public static final int PTR_BCS_Code39
public static final int PTR_BCS_Code93
public static final int PTR_BCS_Code128
public static final int PTR_BCS_UPCA_S
public static final int PTR_BCS_UPCE_S
public static final int PTR_BCS_UPCD1
public static final int PTR_BCS_UPCD2
public static final int PTR_BCS_UPCD3
public static final int PTR_BCS_UPCD4
public static final int PTR_BCS_UPCD5
public static final int PTR_BCS_EAN8_S
public static final int PTR_BCS_EAN13_S
public static final int PTR_BCS_EAN128
public static final int PTR_BCS_OCRA
public static final int PTR_BCS_OCRB
public static final int PTR_BCS_PDF417
public static final int PTR_BCS_MAXICODE
public static final int PTR_BCS_OTHER
public static final int PTR_BC_LEFT
public static final int PTR_BC_CENTER
public static final int PTR_BC_RIGHT
public static final int PTR_BC_TEXT_NONE
public static final int PTR_BC_TEXT_ABOVE
public static final int PTR_BC_TEXT_BELOW
public static final int PTR_BM_ASIS
Method Detail |
public void sendKeySequence(java.lang.String sequence) throws AEFException, java.rmi.RemoteException
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void resendLastKeySequence() throws AEFException, java.rmi.RemoteException
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public java.lang.String getLastKeySequence() throws java.rmi.RemoteException
sendKeySequence
method.
sendKeySequence
method.
java.rmi.RemoteException
public com.ibm.retail.AEF.workstation.KeyCode getKeyCode(int rawscancode) throws java.rmi.RemoteException
java.rmi.RemoteException
public int getLogicalKeyCode(int rawscancode) throws java.rmi.RemoteException
java.rmi.RemoteException
public int getRawScanCode(int logicalcode) throws java.rmi.RemoteException
java.rmi.RemoteException
public java.util.Vector getRawScanCodes(int logicalcode) throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean isRawScanCodeDoubleKey(int scancode) throws java.rmi.RemoteException
scancode
- value to check.
java.rmi.RemoteException
public boolean isLogicalKeyCodeDoubleKey(int keycode) throws java.rmi.RemoteException
keycode
- value to check.
java.rmi.RemoteException
public void setInputDevicesLocked(boolean locked) throws AEFException, java.rmi.RemoteException
locked
- Set true to lock all input devices, false to unlock all input devices.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
AEFException
public boolean getInputDevicesLocked() throws AEFException, java.rmi.RemoteException
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
AEFException
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
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.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
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
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.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void setLineDisplayText(java.lang.String displayLogicalName, java.lang.String text, int row, int col, boolean clear) throws AEFException, java.rmi.RemoteException
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.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void setLineDisplayText(java.lang.String text, int row, int col, boolean clear) throws AEFException, java.rmi.RemoteException
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.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void clearLineDisplay(java.lang.String displayLogicalName) throws AEFException, java.rmi.RemoteException
displayLogicalName
- The logical name of the line display which should be cleared.
Should be LineDisplay1 or LineDisplay2.
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void clearLineDisplay() throws AEFException, java.rmi.RemoteException
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public void printBarCode(int Station, java.lang.String data, int symbology, int width, int height, int alignment, int textPosition) throws java.rmi.RemoteException, AEFException
Station
- PTR_S_RECEIPT, PTR_S_SLIPdata
- The bar code datasymbology
- 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
java.rmi.RemoteException
AEFException
- Possible return codes are:
public void printBitmap(int Station, java.lang.String filename, int width, int alignment) throws java.rmi.RemoteException, AEFException
Station
- PTR_S_JOURNAL, PTR_S_RECEIPT, PTR_S_SLIPfilename
- The filename of the image to printwidth
- Width of the image (defaults to dots)alignment
- PTR_BC_LEFT, PTR_BC_CENTER, PTR_BC_RIGHT
java.rmi.RemoteException
AEFException
- Possible return codes are:
public void printLine(int Station, java.lang.String data) throws java.rmi.RemoteException, AEFException
Station
- PTR_S_RECEIPT, PTR_S_SLIPdata
- The data to print.
java.rmi.RemoteException
AEFException
- Possible return codes are:
public void swipeMSR(byte[] track1Data, byte[] track2Data, byte[] track3Data) throws java.rmi.RemoteException, AEFException
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.
java.rmi.RemoteException
AEFException
- Possible return codes are:
public void swipeMSR(java.lang.String track1Data, java.lang.String track2Data, java.lang.String track3Data) throws java.rmi.RemoteException, AEFException
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.
java.rmi.RemoteException
AEFException
- Possible return codes are:
public void setSession(com.ibm.retail.AEF.session.AEFSession session) throws java.rmi.RemoteException, AEFException
session
-
java.rmi.RemoteException
AEFException
- Possible return codes are:
public com.ibm.retail.AEF.session.AEFSession getSession() throws java.rmi.RemoteException
java.rmi.RemoteException
public void setKeyLockPosition(int position) throws java.rmi.RemoteException, AEFException
position
- Must be either LOCKED_POSITION, NORMAL_POSITION,
SUPERVISOR_POSITION, PHYSICAL_POSITION
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public int getKeyLockPosition() throws java.rmi.RemoteException, AEFException
java.rmi.RemoteException
com.ibm.retail.AEF.util.AEFException
- Possible return codes are:
AEFException
public java.lang.String readPendingMessage() throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean hasPendingMessage() throws java.rmi.RemoteException
java.rmi.RemoteException
public void addKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c) throws java.rmi.RemoteException
java.rmi.RemoteException
KeyConsumer
public void removeKeyConsumer(com.ibm.retail.AEF.workstation.KeyConsumer c) throws java.rmi.RemoteException
java.rmi.RemoteException
KeyConsumer
public void setInputPending(boolean pending) throws java.rmi.RemoteException
java.rmi.RemoteException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |