com.ibm.retail.AEF.event
Interface CashReceiptEvent

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

public interface CashReceiptEvent
extends POSAppEvent

The CashReceiptEvent encapsulates cash receipt printer data obtained from the terminal session.


Method Summary
 int getLineFeeds()
          Get number of line feeds.
 java.util.Collection getPrintLines()
          Returns the print lines associated with this event.
 java.util.Collection getRawPrintLines()
          Return the collection of raw print lines for the event.
 boolean isPaperCut()
          Return true if this a paper cut for the receipt printer.
 
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
 

Method Detail

getPrintLines

public java.util.Collection getPrintLines()
Returns the print lines associated with this event. All special characters (escape sequences) have been filtered out.

Returns:
Collection of strings containing the print lines. - returns empty collection if no print lines exist

getRawPrintLines

public java.util.Collection getRawPrintLines()
Return the collection of raw print lines for the event.

Returns:
Collection of strings containing the raw print lines. - returns empty collection if no print lines exist

isPaperCut

public boolean isPaperCut()
                   throws AEFException
Return true if this a paper cut for the receipt printer.

Returns:
true if paper cut
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getLineFeeds

public int getLineFeeds()
                 throws AEFException
Get number of line feeds.

Returns:
number of line feeds
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE


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