com.ibm.retail.AEF.event
Interface LineItemEvent

All Superinterfaces:
POSAppEvent, POSAppEventElement, SAXElementHandler, java.io.Serializable
All Known Subinterfaces:
CouponEvent, DiscountEvent, ItemSalesEvent, PointsEvent, TenderEvent

public interface LineItemEvent
extends POSAppEvent

LineItemEvent is the parent interface for the hierarchy of events related to items to a POS transaction.

A LineItemEvent is generated when an item is added or removed from a transaction. The LineItemEvent object contains details about the item.


Method Summary
 java.lang.String getDescription()
          Returns the short item description used by POS.
 java.lang.String getItemModifier()
          Returns the item modifier.
 java.util.Collection getPrintLines()
          Returns a collection of print lines (Strings) for the line item.
 java.util.Collection getRawPrintLines()
          Returns a collection of raw print lines (Strings) for the line item.
 boolean isDeposit()
          Indicates whether the line item is a deposit line item.
 boolean isRefunded()
          Indicates whether the line item is a refund line item.
 boolean isVoided()
          Indicates whether the line item is a voided line item.
 
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

getItemModifier

public java.lang.String getItemModifier()
Returns the item modifier. The item modifier is an application dependent value which indicates some additional information about the item.

Returns:
String - returns null if the property is undefined in this event

isVoided

public boolean isVoided()
                 throws AEFException
Indicates whether the line item is a voided line item.

Returns:
true if the line item is voided.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isRefunded

public boolean isRefunded()
                   throws AEFException
Indicates whether the line item is a refund line item.

Returns:
true if the line item is refunded.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isDeposit

public boolean isDeposit()
                  throws AEFException
Indicates whether the line item is a deposit line item.

Returns:
true if the line item is a deposit.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getDescription

public java.lang.String getDescription()
Returns the short item description used by POS.

Returns:
short description of the item as displayed by the POS terminal. - returns null if the property is undefined

getPrintLines

public java.util.Collection getPrintLines()
Returns a collection of print lines (Strings) for the line item. All special characters (escape sequences) have been filtered out.

Returns:
Collection of Strings - returns empty collection if no print lines

getRawPrintLines

public java.util.Collection getRawPrintLines()
Returns a collection of raw print lines (Strings) for the line item.

Returns:
Collection of Strings - returns empty collection if no print lines


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