com.ibm.retail.AEF.event
Interface WorkstationStatusEvent

All Superinterfaces:
POSAppEvent, POSAppEventElement, SAXElementHandler, java.io.Serializable

public interface WorkstationStatusEvent
extends POSAppEvent

WorkstationStatusEvent is an event object generated when the status of the POS workstation changes. String identifiers for the event types are passed through the getTerminalStatus() method.

Example usage:

 if (evt.getTerminalStatus() != null)
 {
   if (evt.getTerminalStatus().equals(WorkstationStatusEvent.INPUT_SEQUENCE_CLEARED)
   {
       System.out.println("Input sequence cleared");
   }
 }
 


Field Summary
static java.lang.String DISABLE_TERMINAL_ACKNOWLEDGED
          Terminal status identifier for "terminal has acknowledged disable terminal command"
static java.lang.String INPUT_SEQUENCE_CLEARED
          Terminal status identifier for "input sequence was cleared" events.
static java.lang.String IS_DOUBLE_CLEAR
          Double clear was pressed.
 
Method Summary
 java.lang.String getTerminalStatus()
          Get the current terminal status
 void setTerminalStatus(java.lang.String status)
          Set the terminal device status
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEvent
getEventType, getPropertyChangeCategory, getTerminalNumber, setEventType, setTerminalNumber
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEventElement
getBooleanPropertyValue, getData, getIntegerPropertyValue, getProperty, getPropertyEntries, setData, setProperty, toString
 
Methods inherited from interface com.ibm.retail.AEF.xml.SAXElementHandler
endElement, startElement
 

Field Detail

INPUT_SEQUENCE_CLEARED

public static final java.lang.String INPUT_SEQUENCE_CLEARED
Terminal status identifier for "input sequence was cleared" events.

To determine if the double clear key was pressed, use getBooleanProperty(WorkstationStatusEvent.IS_DOUBLE_CLEAR)

See Also:
Constant Field Values

IS_DOUBLE_CLEAR

public static final java.lang.String IS_DOUBLE_CLEAR
Double clear was pressed.

See Also:
Constant Field Values

DISABLE_TERMINAL_ACKNOWLEDGED

public static final java.lang.String DISABLE_TERMINAL_ACKNOWLEDGED
Terminal status identifier for "terminal has acknowledged disable terminal command"

See Also:
Constant Field Values
Method Detail

getTerminalStatus

public java.lang.String getTerminalStatus()
Get the current terminal status

Returns:
identifer for terminal status
See Also:
INPUT_SEQUENCE_CLEARED

setTerminalStatus

public void setTerminalStatus(java.lang.String status)
Set the terminal device status

Parameters:
status - the identifier of the current status
See Also:
INPUT_SEQUENCE_CLEARED


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