com.ibm.retail.AEF.data
Interface POSDataProvider

All Superinterfaces:
java.rmi.Remote

public interface POSDataProvider
extends java.rmi.Remote

The POSDataProvider provides listener registration to monitor the properties of its associated terminal session. It also maintains and provides access to the state information for the session.

A POSDataProvider object is created by an AEFSession and is accessed through the getPOSDataProvider accessor in the AEFSession interface.

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

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

State information for the associated session is maintained and is accessible the getPropertyValue method. Property names are contained in the associated POSDataProperties interface class (e.g., property names for options are contained in the OptionsProperties interface).

See Also:
getPOSDataProvider, POSAppEventListener, AEFPropertyChangeListener, getPropertyValue

Method Summary
 void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener)
          Add a property change listener to listen to all data provider property change events.
 void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category)
          Add a filtered property change listener to listen to data provider events for a specific category.
 void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category, java.lang.String property)
          Add a filtered property change listener to listen to data provider events for a specific property.
 void addCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener)
          Add a listener for cash receipt events
 void addCouponListener(com.ibm.retail.AEF.event.CouponListener listener)
          Add a listener for coupon events
 void addCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener)
          Add a listener for customer events
 void addDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener)
          Add a listener for Discount events
 void addItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener)
          Add a listener for item sales events
 void addOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener)
          Add a listener for operator events
 void addOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener)
          Add a listener for initial load or modification to POS options (POS terminal and store options)
 void addPointsListener(com.ibm.retail.AEF.event.PointsListener listener)
          Add a listener for points events
 void addPOSAppEventListener(java.lang.String listenerType, com.ibm.retail.AEF.event.POSAppEventListener listener)
          Generic interface for adding listeners for a specified POSAppEvent listeners.
 void addPOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport)
          Generic "plug-in" interface for adding listener support for POSAppEvent listeners.
 void addReportListener(com.ibm.retail.AEF.event.ReportListener listener)
          Add a listener for Report events generated when report data is available
 void addScaleListener(com.ibm.retail.AEF.event.ScaleListener listener)
          Add a listener for Scale events generated when an item is weighed
 void addStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener)
          Add a listener for POS State Change events
 void addTenderListener(com.ibm.retail.AEF.event.TenderListener listener)
          Add a listener for tender entry events
 void addTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener)
          Add a listener for TransactionStatus events
 void addTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener)
          Add a listener for TransactionTotals events
 void addWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener)
          Add a listener for Workstation status events
 com.ibm.retail.AEF.data.FunctionCodeDefinition[] getGlobalFunctionCodes()
          Gets the global functioncodes from the POS
 java.lang.String getPropertiesAsString()
          Returns a string containing all the property values.
 java.lang.Object getPropertyValue(java.lang.String property)
          Get a property value for a specified property name.
 java.lang.Object getPropertyValue(java.lang.String category, java.lang.String property)
          Get a property value for a specified category and property name.
 java.lang.Object getPropertyValue(java.lang.String category, java.lang.String property, boolean waitForPending)
          Get a property value for a specified category and property name.
 com.ibm.retail.AEF.session.AEFSession getSession()
          Gets the AEFSession for this instance.
 com.ibm.retail.AEF.data.StateDefinition getStateDefinition(int stateID)
          Gets the POS StateDefinition for a state ID.
 void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener)
          Remove a property change listener.
 void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category)
          Remove a filtered property change listener
 void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category, java.lang.String property)
          Remove a filtered property change listener
 void removeAllListeners(java.lang.Object listener)
          Remove a listener from all listener vectors
 void removeCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener)
          Remove a listener for cash receipt events
 void removeCouponListener(com.ibm.retail.AEF.event.CouponListener listener)
          Remove a listener for coupon events
 void removeCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener)
          Remove a listener for customer events
 void removeDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener)
          Remove a listener for Discount events
 void removeItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener)
          Remove a listener for item sales events
 void removeOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener)
          Remove a listener for operator events
 void removeOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener)
          Remove a listener for initial load or modification to POS options (POS terminal and store options)
 void removePointsListener(com.ibm.retail.AEF.event.PointsListener listener)
          Remove a listener for points events
 void removePOSAppEventListener(java.lang.String listenerType, com.ibm.retail.AEF.event.POSAppEventListener listener)
          Generic interface for removing listeners for a specified POSAppEvent listeners.
 void removePOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport)
          Generic "plug-in" interface for removing listener support for POSAppEvent listeners
 void removeReportListener(com.ibm.retail.AEF.event.ReportListener listener)
          Remove a report listener
 void removeScaleListener(com.ibm.retail.AEF.event.ScaleListener listener)
          Remove a scale listener
 void removeStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener)
          Remove a listener for StateChange events
 void removeTenderListener(com.ibm.retail.AEF.event.TenderListener listener)
          Remove a listener for tender entry events
 void removeTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener)
          Remove a listener for TransactionStatus events
 void removeTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener)
          Remove a listener for TransactionTotals events
 void removeWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener)
          Remove a listener for WorkstationStatus events
 void setPropertyValue(java.lang.String category, java.lang.String property, java.lang.Object value)
          Set a property value for a specified category and property name.
 void setSession(com.ibm.retail.AEF.session.AEFSession session)
          Sets the AEFSession for this instance.
 

Method Detail

addItemSalesListener

public void addItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener)
                          throws java.rmi.RemoteException,
                                 AEFException
Add a listener for item sales events

Parameters:
listener - the ItemSalesListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeItemSalesListener

public void removeItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener)
                             throws java.rmi.RemoteException,
                                    AEFException
Remove a listener for item sales events

Parameters:
listener - the ItemSalesListener to be removed
Throws:
java.rmi.RemoteException - if remote access fails
AEFException - if listener can not be added

addCashReceiptListener

public void addCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Add a listener for cash receipt events

Parameters:
listener - the CashReceiptListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeCashReceiptListener

public void removeCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener)
                               throws java.rmi.RemoteException,
                                      AEFException
Remove a listener for cash receipt events

Parameters:
listener - the CashReceiptListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addTenderListener

public void addTenderListener(com.ibm.retail.AEF.event.TenderListener listener)
                       throws java.rmi.RemoteException,
                              AEFException
Add a listener for tender entry events

Parameters:
listener - the TenderListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeTenderListener

public void removeTenderListener(com.ibm.retail.AEF.event.TenderListener listener)
                          throws java.rmi.RemoteException,
                                 AEFException
Remove a listener for tender entry events

Parameters:
listener - the TenderListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addCouponListener

public void addCouponListener(com.ibm.retail.AEF.event.CouponListener listener)
                       throws java.rmi.RemoteException,
                              AEFException
Add a listener for coupon events

Parameters:
listener - the CoupnListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeCouponListener

public void removeCouponListener(com.ibm.retail.AEF.event.CouponListener listener)
                          throws java.rmi.RemoteException,
                                 AEFException
Remove a listener for coupon events

Parameters:
listener - the CouponListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addCustomerListener

public void addCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener)
                         throws java.rmi.RemoteException,
                                AEFException
Add a listener for customer events

Parameters:
listener - the CustomerListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeCustomerListener

public void removeCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Remove a listener for customer events

Parameters:
listener - the CustomerListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addPointsListener

public void addPointsListener(com.ibm.retail.AEF.event.PointsListener listener)
                       throws java.rmi.RemoteException,
                              AEFException
Add a listener for points events

Parameters:
listener - the PointsListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removePointsListener

public void removePointsListener(com.ibm.retail.AEF.event.PointsListener listener)
                          throws java.rmi.RemoteException,
                                 AEFException
Remove a listener for points events

Parameters:
listener - the PointsListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addOperatorListener

public void addOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener)
                         throws java.rmi.RemoteException,
                                AEFException
Add a listener for operator events

Parameters:
listener - the OperatorListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeOperatorListener

public void removeOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Remove a listener for operator events

Parameters:
listener - the OperatorListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addOptionsListener

public void addOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener)
                        throws java.rmi.RemoteException,
                               AEFException
Add a listener for initial load or modification to POS options (POS terminal and store options)

Parameters:
listener - the OptionsListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeOptionsListener

public void removeOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener)
                           throws java.rmi.RemoteException,
                                  AEFException
Remove a listener for initial load or modification to POS options (POS terminal and store options)

Parameters:
listener - the OperatorListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addDiscountListener

public void addDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener)
                         throws java.rmi.RemoteException,
                                AEFException
Add a listener for Discount events

Parameters:
listener - the DiscountListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeDiscountListener

public void removeDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Remove a listener for Discount events

Parameters:
listener - the DiscountListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addTransactionTotalsListener

public void addTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener)
                                  throws java.rmi.RemoteException,
                                         AEFException
Add a listener for TransactionTotals events

Parameters:
listener - the TransactionTotalsListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeTransactionTotalsListener

public void removeTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener)
                                     throws java.rmi.RemoteException,
                                            AEFException
Remove a listener for TransactionTotals events

Parameters:
listener - the TransactionTotalsListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addTransactionStatusListener

public void addTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener)
                                  throws java.rmi.RemoteException,
                                         AEFException
Add a listener for TransactionStatus events

Parameters:
listener - the TransactionStatusListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeTransactionStatusListener

public void removeTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener)
                                     throws java.rmi.RemoteException,
                                            AEFException
Remove a listener for TransactionStatus events

Parameters:
listener - the TransactionStatusListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addReportListener

public void addReportListener(com.ibm.retail.AEF.event.ReportListener listener)
                       throws java.rmi.RemoteException,
                              AEFException
Add a listener for Report events generated when report data is available

Parameters:
listener - the ReportListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeReportListener

public void removeReportListener(com.ibm.retail.AEF.event.ReportListener listener)
                          throws java.rmi.RemoteException,
                                 AEFException
Remove a report listener

Parameters:
listener - the ReportListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addScaleListener

public void addScaleListener(com.ibm.retail.AEF.event.ScaleListener listener)
                      throws java.rmi.RemoteException,
                             AEFException
Add a listener for Scale events generated when an item is weighed

Parameters:
listener - the ScaleListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeScaleListener

public void removeScaleListener(com.ibm.retail.AEF.event.ScaleListener listener)
                         throws java.rmi.RemoteException,
                                AEFException
Remove a scale listener

Parameters:
listener - the ScaleListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addStateChangeListener

public void addStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Add a listener for POS State Change events

Parameters:
listener - the StateChangeListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeStateChangeListener

public void removeStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener)
                               throws java.rmi.RemoteException,
                                      AEFException
Remove a listener for StateChange events

Parameters:
listener - the StateChangeListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addWorkstationStatusListener

public void addWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener)
                                  throws java.rmi.RemoteException,
                                         AEFException
Add a listener for Workstation status events

Parameters:
listener - the WorkstationStatusListener to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removeWorkstationStatusListener

public void removeWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener)
                                     throws java.rmi.RemoteException,
                                            AEFException
Remove a listener for WorkstationStatus events

Parameters:
listener - the WorkstationStatusListener to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addPOSAppEventListenerSupport

public void addPOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport)
                                   throws java.rmi.RemoteException
Generic "plug-in" interface for adding listener support for POSAppEvent listeners.

This method allows additional listener interfaces to be added to the POSDataProvider.

Parameters:
listenerSupport - the listenerSupport object to be added
Throws:
java.rmi.RemoteException - if remote access fails

removePOSAppEventListenerSupport

public void removePOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport)
                                      throws java.rmi.RemoteException
Generic "plug-in" interface for removing listener support for POSAppEvent listeners

Parameters:
listenerSupport - the listenerSupport object to be removed
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addPOSAppEventListener

public void addPOSAppEventListener(java.lang.String listenerType,
                                   com.ibm.retail.AEF.event.POSAppEventListener listener)
                            throws java.rmi.RemoteException,
                                   AEFException
Generic interface for adding listeners for a specified POSAppEvent listeners.

This method provides a generic interface for adding a listener. It is provided as an extension mechanism to allow additional listener interfaces to be added.

Clients should use the provided specific addListener methods for adding AEF provided listeners such as CashReceipt, TransactionTotalsListener,....

Parameters:
listenerType - fully qualified classname of listener interface
listener - the listener object to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

removePOSAppEventListener

public void removePOSAppEventListener(java.lang.String listenerType,
                                      com.ibm.retail.AEF.event.POSAppEventListener listener)
                               throws java.rmi.RemoteException,
                                      AEFException
Generic interface for removing listeners for a specified POSAppEvent listeners.

This method provides a generic interface for removing a listener. It is provided as an extension mechanism to allow additional listener interfaces to be added.

Clients should use the provided specific removeListener methods for removing AEF provided listeners such as CashReceipt, TransactionTotalsListener,....

Parameters:
listenerType - fully qualified classname of listener interface
listener - the listener object to be added
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_LISTENER_SUPPORT

addAEFPropertyChangeListener

public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener)
                                  throws java.rmi.RemoteException
Add a property change listener to listen to all data provider property change events.

Note: Due to the large number of property change events, it is best to use a specific event listener (e.g., TransactionTotalsListener) or a filtered property change listener (e.g., a listener for a change to the POS_STATE property). Filtered listeners restrict the events to a specific category or property to be monitored.

Parameters:
listener - the AEFPropertyChangeListener to be added
Throws:
java.rmi.RemoteException

removeAEFPropertyChangeListener

public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener)
                                     throws java.rmi.RemoteException
Remove a property change listener.

Parameters:
listener - the AEFPropertyChangeListener to be removed
Throws:
java.rmi.RemoteException

addAEFPropertyChangeListener

public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener,
                                         java.lang.String category)
                                  throws java.rmi.RemoteException
Add a filtered property change listener to listen to data provider events for a specific category.

Note: Due to the large number of property change events, it is best to use a specific event listener (e.g., TransactionTotalsListener) or a filtered property change listener (e.g., a listener for a change to the POS_STATE property).

Parameters:
listener - the AEFPropertyChangeListener to be added
category - identifies the category of data (provides filter)
Throws:
java.rmi.RemoteException

removeAEFPropertyChangeListener

public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener,
                                            java.lang.String category)
                                     throws java.rmi.RemoteException
Remove a filtered property change listener

Parameters:
listener - the AEFPropertyChangeListener to be removed
category - identifies the category of data
Throws:
java.rmi.RemoteException

addAEFPropertyChangeListener

public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener,
                                         java.lang.String category,
                                         java.lang.String property)
                                  throws java.rmi.RemoteException
Add a filtered property change listener to listen to data provider events for a specific property.

Parameters:
listener - the PropertyChangeListener to be added
category - identifies the category of data
property - identifies the property data
Throws:
java.rmi.RemoteException

removeAEFPropertyChangeListener

public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener,
                                            java.lang.String category,
                                            java.lang.String property)
                                     throws java.rmi.RemoteException
Remove a filtered property change listener

Parameters:
listener - the PropertyChangeListener to be removed
category - identifies the category of data
property - identifies the property data
Throws:
java.rmi.RemoteException

setPropertyValue

public void setPropertyValue(java.lang.String category,
                             java.lang.String property,
                             java.lang.Object value)
                      throws java.rmi.RemoteException
Set a property value for a specified category and property name.

Parameters:
category - identifies the category name of the data
property - identifies the property name of the data
value - the property value to be added or updated
Throws:
java.rmi.RemoteException

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String category,
                                         java.lang.String property)
                                  throws java.rmi.RemoteException
Get a property value for a specified category and property name. This version will wait for any pending property changes on the queue.

A null value is returned if the property is not found, and no exception is thrown.

Parameters:
category - identifies the category name of the data
property - identifies the property name of the data
Returns:
the property value requested or null if the property does not exist
Throws:
java.rmi.RemoteException

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String property)
                                  throws java.rmi.RemoteException
Get a property value for a specified property name. This version will wait for any pending property changes on the queue. Each category will be examined until the first property with the specified name is located. The value of the first property located with the requested name will be returned.

A null value is returned if the property is not found, and no exception is thrown.

Parameters:
property - identifies the property name of the data
Returns:
the property value requested or null if the property does not exist
Throws:
java.rmi.RemoteException

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String category,
                                         java.lang.String property,
                                         boolean waitForPending)
                                  throws java.rmi.RemoteException
Get a property value for a specified category and property name.

A null value is returned if the property is not found, and no exception is thrown.

Parameters:
category - identifies the category name of the data
property - identifies the property name of the data
waitForPending - True to wait for any pending property changes already on the queue.
Returns:
the property value requested or null if the property does not exist
Throws:
java.rmi.RemoteException

removeAllListeners

public void removeAllListeners(java.lang.Object listener)
                        throws java.rmi.RemoteException
Remove a listener from all listener vectors

Parameters:
listener - Object to be removed
Throws:
java.rmi.RemoteException

getPropertiesAsString

public java.lang.String getPropertiesAsString()
                                       throws java.rmi.RemoteException
Returns a string containing all the property values. Useful for debugging.

Returns:
String
Throws:
java.rmi.RemoteException

setSession

public void setSession(com.ibm.retail.AEF.session.AEFSession session)
                throws java.rmi.RemoteException
Sets the AEFSession for this instance.

Parameters:
session - AEFSession associated with this object
Throws:
java.rmi.RemoteException

getSession

public com.ibm.retail.AEF.session.AEFSession getSession()
                                                 throws java.rmi.RemoteException
Gets the AEFSession for this instance.

Returns:
AEFSession associated with this object
Throws:
java.rmi.RemoteException

getStateDefinition

public com.ibm.retail.AEF.data.StateDefinition getStateDefinition(int stateID)
                                                           throws java.rmi.RemoteException
Gets the POS StateDefinition for a state ID.

Parameters:
stateID - the identifier for the state
Returns:
StateDefinition
Throws:
java.rmi.RemoteException

getGlobalFunctionCodes

public com.ibm.retail.AEF.data.FunctionCodeDefinition[] getGlobalFunctionCodes()
                                                                        throws java.rmi.RemoteException
Gets the global functioncodes from the POS

Returns:
FunctionCodeDefinition[]
Throws:
java.rmi.RemoteException


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