|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
AEFPropertyChangeListeners
are fine-grained property change events which allow a specific, individual
property to be observed. Example: transaction total for tax.
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).
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 |
public void addItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ItemSalesListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeItemSalesListener(com.ibm.retail.AEF.event.ItemSalesListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ItemSalesListener to be removed
java.rmi.RemoteException
- if remote access fails
AEFException
- if listener can not be addedpublic void addCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CashReceiptListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeCashReceiptListener(com.ibm.retail.AEF.event.CashReceiptListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CashReceiptListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addTenderListener(com.ibm.retail.AEF.event.TenderListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TenderListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeTenderListener(com.ibm.retail.AEF.event.TenderListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TenderListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addCouponListener(com.ibm.retail.AEF.event.CouponListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CoupnListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeCouponListener(com.ibm.retail.AEF.event.CouponListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CouponListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CustomerListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeCustomerListener(com.ibm.retail.AEF.event.CustomerListener listener) throws java.rmi.RemoteException, AEFException
listener
- the CustomerListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addPointsListener(com.ibm.retail.AEF.event.PointsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the PointsListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removePointsListener(com.ibm.retail.AEF.event.PointsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the PointsListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener) throws java.rmi.RemoteException, AEFException
listener
- the OperatorListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeOperatorListener(com.ibm.retail.AEF.event.OperatorListener listener) throws java.rmi.RemoteException, AEFException
listener
- the OperatorListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the OptionsListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeOptionsListener(com.ibm.retail.AEF.event.OptionsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the OperatorListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener) throws java.rmi.RemoteException, AEFException
listener
- the DiscountListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeDiscountListener(com.ibm.retail.AEF.event.DiscountListener listener) throws java.rmi.RemoteException, AEFException
listener
- the DiscountListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TransactionTotalsListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeTransactionTotalsListener(com.ibm.retail.AEF.event.TransactionTotalsListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TransactionTotalsListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TransactionStatusListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeTransactionStatusListener(com.ibm.retail.AEF.event.TransactionStatusListener listener) throws java.rmi.RemoteException, AEFException
listener
- the TransactionStatusListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addReportListener(com.ibm.retail.AEF.event.ReportListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ReportListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeReportListener(com.ibm.retail.AEF.event.ReportListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ReportListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addScaleListener(com.ibm.retail.AEF.event.ScaleListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ScaleListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeScaleListener(com.ibm.retail.AEF.event.ScaleListener listener) throws java.rmi.RemoteException, AEFException
listener
- the ScaleListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener) throws java.rmi.RemoteException, AEFException
listener
- the StateChangeListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeStateChangeListener(com.ibm.retail.AEF.event.StateChangeListener listener) throws java.rmi.RemoteException, AEFException
listener
- the StateChangeListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener) throws java.rmi.RemoteException, AEFException
listener
- the WorkstationStatusListener to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removeWorkstationStatusListener(com.ibm.retail.AEF.event.WorkstationStatusListener listener) throws java.rmi.RemoteException, AEFException
listener
- the WorkstationStatusListener to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addPOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport) throws java.rmi.RemoteException
This method allows additional listener interfaces to be added to the POSDataProvider.
listenerSupport
- the listenerSupport object to be added
java.rmi.RemoteException
- if remote access failspublic void removePOSAppEventListenerSupport(com.ibm.retail.AEF.event.POSAppEventListenerSupport listenerSupport) throws java.rmi.RemoteException
listenerSupport
- the listenerSupport object to be removed
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addPOSAppEventListener(java.lang.String listenerType, com.ibm.retail.AEF.event.POSAppEventListener listener) throws java.rmi.RemoteException, AEFException
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,...
.
listenerType
- fully qualified classname of listener interfacelistener
- the listener object to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void removePOSAppEventListener(java.lang.String listenerType, com.ibm.retail.AEF.event.POSAppEventListener listener) throws java.rmi.RemoteException, AEFException
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,...
.
listenerType
- fully qualified classname of listener interfacelistener
- the listener object to be added
java.rmi.RemoteException
AEFException
- Among the possible AEFException error codes are:
public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener) throws java.rmi.RemoteException
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.
listener
- the AEFPropertyChangeListener to be added
java.rmi.RemoteException
public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener) throws java.rmi.RemoteException
listener
- the AEFPropertyChangeListener to be removed
java.rmi.RemoteException
public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category) throws java.rmi.RemoteException
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).
listener
- the AEFPropertyChangeListener to be addedcategory
- identifies the category of data (provides filter)
java.rmi.RemoteException
public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category) throws java.rmi.RemoteException
listener
- the AEFPropertyChangeListener to be removedcategory
- identifies the category of data
java.rmi.RemoteException
public void addAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category, java.lang.String property) throws java.rmi.RemoteException
listener
- the PropertyChangeListener to be addedcategory
- identifies the category of dataproperty
- identifies the property data
java.rmi.RemoteException
public void removeAEFPropertyChangeListener(com.ibm.retail.AEF.event.AEFPropertyChangeListener listener, java.lang.String category, java.lang.String property) throws java.rmi.RemoteException
listener
- the PropertyChangeListener to be removedcategory
- identifies the category of dataproperty
- identifies the property data
java.rmi.RemoteException
public void setPropertyValue(java.lang.String category, java.lang.String property, java.lang.Object value) throws java.rmi.RemoteException
category
- identifies the category name of the dataproperty
- identifies the property name of the datavalue
- the property value to be added or updated
java.rmi.RemoteException
public java.lang.Object getPropertyValue(java.lang.String category, java.lang.String property) throws java.rmi.RemoteException
A null value is returned if the property is not found, and no exception is thrown.
category
- identifies the category name of the dataproperty
- identifies the property name of the data
java.rmi.RemoteException
public java.lang.Object getPropertyValue(java.lang.String property) throws java.rmi.RemoteException
A null value is returned if the property is not found, and no exception is thrown.
property
- identifies the property name of the data
java.rmi.RemoteException
public java.lang.Object getPropertyValue(java.lang.String category, java.lang.String property, boolean waitForPending) throws java.rmi.RemoteException
A null value is returned if the property is not found, and no exception is thrown.
category
- identifies the category name of the dataproperty
- identifies the property name of the datawaitForPending
- True to wait for any pending property changes already on the queue.
java.rmi.RemoteException
public void removeAllListeners(java.lang.Object listener) throws java.rmi.RemoteException
listener
- Object to be removed
java.rmi.RemoteException
public java.lang.String getPropertiesAsString() throws java.rmi.RemoteException
java.rmi.RemoteException
public void setSession(com.ibm.retail.AEF.session.AEFSession session) throws java.rmi.RemoteException
session
- AEFSession associated with this object
java.rmi.RemoteException
public com.ibm.retail.AEF.session.AEFSession getSession() throws java.rmi.RemoteException
java.rmi.RemoteException
public com.ibm.retail.AEF.data.StateDefinition getStateDefinition(int stateID) throws java.rmi.RemoteException
stateID
- the identifier for the state
java.rmi.RemoteException
public com.ibm.retail.AEF.data.FunctionCodeDefinition[] getGlobalFunctionCodes() throws java.rmi.RemoteException
java.rmi.RemoteException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |