com.ibm.retail.saf.provider
Interface PriceResult

All Superinterfaces:
POSInfo, POSResult, java.io.Serializable
All Known Implementing Classes:
DefaultPriceResult

public interface PriceResult
extends POSResult

Contains the results obtained from performing a price lookup on the point-of-sale system.

PriceResult is used by POSProvider which provide a pricing API. Results from a price request are put in a PriceResult object and returned to the client.


Method Summary
 int getNumberOfPrices()
          Gets the total number of items in this PriceResult.
 com.ibm.retail.saf.provider.PriceInfo getPrice(com.ibm.retail.saf.provider.ItemIdentifier itemID)
          Gets the price of an item in this PriceResult.
 java.util.Iterator itemIdentifiers()
          Gets an iterator for the item identifiers defined for this PriceResult.
 
Methods inherited from interface com.ibm.retail.saf.provider.POSResult
getExceptions, hasExceptions
 
Methods inherited from interface com.ibm.retail.saf.provider.POSInfo
getExtendedAttribute, getExtendedAttributeNames, removeExtendedAttribute, setExtendedAttribute
 

Method Detail

getPrice

public com.ibm.retail.saf.provider.PriceInfo getPrice(com.ibm.retail.saf.provider.ItemIdentifier itemID)
                                               throws POSException
Gets the price of an item in this PriceResult.

Parameters:
itemID - ItemIdentifier key used to access the price.
Returns:
price of the item.
Throws:
POSException - if the price is not found

getNumberOfPrices

public int getNumberOfPrices()
                      throws POSException
Gets the total number of items in this PriceResult.

Returns:
total number of items.
Throws:
POSException - if the price is not found

itemIdentifiers

public java.util.Iterator itemIdentifiers()
Gets an iterator for the item identifiers defined for this PriceResult.

Entries returned by the iterator are of type ItemIdentifier. The ItemIdentifier is the number used to sell the item at the point-of-sale register. Examples include UPC, SKU, or PLU codes.

Returns:
iterator for the items contained in price list.