Package com.ibm.retail.AEF.event

Provides listener and event interfaces used by the AEF POSDataProvider.

See:
          Description

Interface Summary
AEFPropertyChangeListener AEFPropertyChangeListener interface is the interface for receiving AEF property change events from the POSDataProvider API.
CashReceiptEvent The CashReceiptEvent encapsulates cash receipt printer data obtained from the terminal session.
CashReceiptListener Listener interface for receiving cash receipt printer events from the terminal session.
CouponEvent A CouponEvent is generated when a coupon is applied to an item or transaction.
CouponListener Listener interface for receiving CouponEvents from the terminal session.
CustomerEvent A CustomerEvent is generated when a customer is identified by scanning or swiping a customer identification or loyalty card.
CustomerListener Listener interface for receiving CustomerEvent from the terminal session.
DepartmentDefinition A DepartmentDefinition is a simple data object to contain information about POS departments.
DiscountEvent A DiscountEvent is generated by a POS transaction when a discount is applied to the transaction or an item.
DiscountListener Listener interface for receiving discount events from the terminal session.
DiscountReasonCode A DiscountReasonCode is a simple data object to contain information about a POS discount reason code.
ItemSalesEvent An ItemSalesEvent is generated when an item is added or removed from a transaction.
ItemSalesListener Listener interface for receiving item events from the terminal session.
LineItemEvent LineItemEvent is the parent interface for the hierarchy of events related to items to a POS transaction.
OperatorEvent An OperatorEvent is generated when an operator signs on or off a POS terminal.
OperatorListener Listener interface for receiving OperatorEvents from the terminal session.
OptionsEvent An OptionsEvent is generated whenever terminal or store level options are loaded for the POS Terminal Sales Application.
OptionsListener Listener interface for receiving OptionsEvents from the terminal session.
PointsEvent A PointsEvent is generated when loyalty points are awarded or redeemed in a transaction.
PointsListener Listener interface for receiving PointsEvents from the terminal session.
POSAppEvent POSAppEvent is the base interface for events generated for POS application data.
POSAppEventElement POSAppEventElement is an interface which encapsulates events generated via POS application data.
POSAppEventListener POSAppEventListener is the base interface for all listeners of POSAppEvents generated by the POSDataProvider API.
ReasonCode A ReasonCode is a simple data object to contain information about POS reason codes for refunds, discounts, etc.
ReportEvent A ReportEvent contains report information from the POS application.
ReportListener Listener interface for receiving ReportEvents from the terminal session.
ReportSection A ReportSection is a data object containing information about a section of a report.
ScaleEvent A ScaleEvent is generated when an item is weighed.
ScaleListener Listener interface for receiving ScaleEvents from the terminal session.
StateChangeEvent StateChangeEvent is an event object generated when the State of the POS application changes.
StateChangeListener Listener interface for receiving StateChangeEvents from the terminal POS session.
StoreDefinition StoreDefinition is an interface for objects containing the store attrbutes.
StoreOptions StoreOptions is a simple data object to contain information about POS store level options.
TareCode TareCode is a simple data object to contain information about POS tares.
TaxCode A TaxCode is a simple data object to contain information about POS tax code definitions.
TenderDefinition A TenderDefinition is a simple data object to contain information about POS tenders (Cash, Check, Credit,..).
TenderEvent A TenderEvent is generated when a tender is accepted or cancelled within a sales transaction.
TenderListener Listener interface for receiving TenderEvents from the terminal session.
TerminalOptions TerminalOptions is a simple data object to contain information about POS terminal options.
TimeInterval TimeInterval - Encapsulates a time interval when an item may made available for sale, or restricted from sale.
TransactionDefinition A TransactionDefinition is a simple data object to contain information about POS transactions (Regular Sale, No Sale, COD,..).
TransactionDiscountReasonCode TransactionDiscountReasonCode is a simple data object to contain information about POS discount reason code for a transaction.
TransactionStatusEvent A TransactionStatusEvent is created when the status of a sales transaction is changed.
TransactionStatusListener Listener interface for receiving transaction status events from the terminal session.
TransactionTotalsEvent A TransactionTotalsEvent is created when the totals for a sales transaction are updated.
TransactionTotalsListener Listener interface for receiving transaction running totals from the terminal session.
WorkstationStatusEvent WorkstationStatusEvent is an event object generated when the status of the POS workstation changes.
WorkstationStatusListener Listener interface for receiving WorkstationStatusEvents from the terminal POS session.
 

Class Summary
AEFPropertyChangeEvent An AEFPropertyChangeEvent is created when a property contained in the AEF POSDataProvider is modified.
PointsTotal A PointsTotal is a simple data object to contain information about customer loyalty points.
 

Package com.ibm.retail.AEF.event Description

Provides listener and event interfaces used by the AEF POSDataProvider.

The event package defines the events and listener interfaces used by the POSDataProvider. The POSDataProvider allows applications to monitor the data events associated with a POS application. Data events provide information which reflects the current state of the POS application including transaction totals, line items, and customer loyalty information.

Event information is obtained through a standard event listener registration and notification process. Listeners must implement the appropriate listener interface and register with the POSDataProvider through an addListener method. When an event occurs (e.g., the transaction totals change), the client listener is notified by a call through the listener interface. Event objects contain the details of the event.

Usage Notes:

Handling Missing Event Properties

AEF event objects provide a means of passing data from a POS terminal sales application to the AEF POSDataProvider listeners. Since POS applications differ in their data requirements, the event objects provide a flexible interface that allows for both adding new attibutes and removing undefined properties from an event. For example, while the TransactionTotalsEvent provides an accessor for getFoodStampTotal, some POS applications may not provide this data. In this case, a null value is returned by the getFoodStampTotal method. If a method with a boolean return value is invoked and the property is missing from the event object, an AEFException is thrown by the event interface with an error code of AEFConst.NO_SUCH_PROPERTY. It is the responsibility of the client listener to determine the appropriate action for undefined event properties.

Accessing Additional Event Properties

An AEF POS application may add additional properties to an event without electing to extend the event interface with a new accessor. All data is contained within the event as property-value pairs and may be accessed through the getProperty method of the POSAppEventElement base class. The getPropertyEntries method provides an Iterator of all property-value pairs.

Sample Usage:


sample code here...



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