Package com.ibm.retail.AEF.data

Provides interface for monitoring data events associated with the POS application.

See:
          Description

Interface Summary
ApplicationDataConnector ApplicationDataConnector is the interface which used by the POS application to provide application data to the AEF.
CouponProperties CouponProperties contains the data provider property names for coupon attributes.
CustomerProperties CustomerProperties contains the data provider property names for customer attributes.
DiscountProperties DiscountProperties contains the data provider property names for discount attributes.
FunctionCodeDefinition A FunctionCodeDefinition is a simple data object to contain information about a function code used by a POS Sales application.
ItemSalesProperties ItemSalesProperties contains the data provider property names for line item sales properties.
LineItemProperties LineItemProperties contains the data provider property names for line item attributes.
OperatorAuthorizationProperties OperatorAuthorizationProperties contains the data provider property names for operator properties and authorization flags.
OptionsProperties OptionsProperties contains the data provider property names for terminal and store level options.
PointsProperties PointsProperties contains the data provider property names for points attributes.
POSDataProperties POSDataProperties contains the base data provider property names.
POSDataProvider The POSDataProvider provides listener registration to monitor the properties of its associated terminal session.
POSDeviceProperties POSDeviceProperties contains the data provider property names for POS device and IO processor attributes.
StoreOptionsProperties StoreOptionsProperties contains the POSDataProvider property names for store options attributes.
StoreProperties StoreProperties contains the data provider property names for store attributes.
TenderProperties TenderProperties contains the POSDataProvider names for tender attributes.
TerminalOptionsProperties TerminalOptionsProperties contains the property name identifiers for TerminalOptions objects contained in OptionsEvent.
TransactionStatusProperties TransactionStatusProperties provides the POSDataProvider for the transaction status-related data and events provided through the POSDataProvider API.
TransactionTotalsProperties TransactionTotalsProperties provides POSDataProvider property names for the totals associated with a transaction.
WorkstationStatusProperties WorkstationStatusProperties contains the POSDataProvider property names for workstation attributes.
 

Package com.ibm.retail.AEF.data Description

Provides interface for monitoring data events associated with the POS application.

The data package includes the POSDataProvider interface which 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. An event object is passed containing the details of the event. The appropriate removeListener method of POSDataProvider should be invoked when the client no longer requires event notification. See the event package for information about the listener interfaces and event classes.

The POSDataProvider supports a number of event listener interfaces which can be divided into two main categories:

  1. AEFPropertyChangeListeners
    are fine-grained property change events which allow a specific, individual property to be observed.
  2. POSAppEventListeners
    are coarse-grained events which aggregate related data. This allows fewer events but may provide the listener with more data than required.

Usage Notes:

Client Proxy Classes for Listeners

The listener interfaces provided by the AEF extend the java.rmi.Remote interface and therefore allow clients to register as "remote" listeners (through RMI) to the POSDataProvider. Since listener registration requires a reference to the client listener for event notification, this implies that the remote client extend the appropriate RMI server classes in order to allow a remote reference to be passed during listener registration (otherwise, an attempt will be made to serialize the listener object). The AEF provides a client package which provides client proxy classes to handle the RMI duties and provide an event dispatching mechanism for AEF listeners.

Category and Property Names

The AEFPropertyPropertyChangeListener interface allows listeners to register for notification of change to a specific property in the POSDataProvider. A category defines a logical grouping of properties such as transaction totals or item data. String identifiers for the property names are provided in corresponding interfaces. For example, the property name for the current transaction total is accessible as TransactionTotalsProperties.TOTAL.

Accessing Property Values

The POSDataProvider contains a data repository of the current property values. These values are accessible through the getPropertyValue methods.

Sample Usage:


sample code here...



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