Package com.ibm.retail.saf.provider

Provides client interface for sending requests to a point-of-sale system.

See:
          Description

Interface Summary
CashReceiptImage Provides an image of the point-of-sale register cash receipt.
CreditPaymentInfo Contains the credit card information needed to tender payment at the point-of-sale system.
ItemIdentifier Provides information needed to identify an item at the point-of-sale register.
LineItem Provides item identifier and quantity information for an item.
LogRequest Provides information needed to log an exception in the point-of-sale exception log.
PaymentInfo Base interface for payment classes.
PaymentRequest Provides payment information needed to tender a point-of-sale transaction.
PaymentResult Contains the results obtained from performing a payment on the point-of-sale system.
POSInfo Provides an extensible interface for exchanging information with the point-of-sale system using attributes.
POSProvider Provides the common superinterface to define specific modes of accessing the point-of-sale system.
POSProviderFactory Provides a factory API to obtain instances of POSProvider objects.
POSRequest Provides the information needed to process a client request for a point-of-sale operation.
POSRequestFactory Provides a factory API to obtain instances of objects needed to create requests for the POS.
POSResult Contains information returned from the point-of-sale system.
PriceChecker Accepts requests to perform price inquiries on a point-of-sale system.
PriceInfo Contains price information about an item in the point-of-sale system.
PriceProvider Accepts requests to perform price inquiries on a point-of-sale system.
PriceRequest Provides information needed to determine prices for the list of items.
PriceResult Contains the results obtained from performing a price lookup on the point-of-sale system.
PrintLine PrintLine provides access to the line that was sent to the point-of-sale printer by the POS application.
ProviderRequest Provides the information needed to process a client request for an instance of a POSProvider.
ReceiptLineItem Provides the information resulting from the sale of an item at the point-of-sale register.
SalesProvider Accepts requests from a client application to process transactions on a point-of-sale system.
SalesTransaction Provides an interface to perform point-of-sale operations with an active POS transaction.
StateConstants Defines constants for POS transaction states.
Transaction Provides an interface to perform point-of-sale operations with an active POS transaction.
TransactionID Provides a unique identification of a transaction.
TransactionRequest Provides the item and customer information to be added to a point-of-sale transaction.
TransactionResult Contains the results of processing a point-of-sale transaction.
TransactionTotals Provides the totals associated with performing a transaction at the point-of-sale register.
 

Class Summary
CreditCard Contains information required to process a credit card payment.
Default4690CashReceipt Image of cash receipt from an IBM 4690 POS terminal.
Default4690PrintLine Base implementation of PrintLine
DefaultLineItem Provides item and quantity information for an item.
DefaultLogRequest Provides information needed to log an exception in the point-of-sale exception log.
DefaultPaymentRequest Provides a base implementation of a PaymentRequest.
DefaultPaymentResult Provides a base implementation of a PaymentResult.
DefaultPOSRequestFactory Provides an base implementation of POSRequestFactory.
DefaultPriceInfo Contains price information about an item in the point-of-sale system.
DefaultPriceRequest Provides a list of item numbers and qualifying information needed to determine unit price information for the list of items.
DefaultPriceResult Contains the results obtained from performing a price lookup on the point-of-sale system.
DefaultProviderRequest Provides a base implementation of a ProviderRequest.
DefaultReceiptLineItem Implements the ReceiptLineItem interface.
DefaultTransactionID Provides a base implementation of a TransactionID.
DefaultTransactionRequest Provides item information to a point-of-sale transaction.
DefaultTransactionResult Contains the results of processing a point-of-sale transaction.
DefaultTransactionTotals Provides a base implementation of a TransactionTotals.
POSInfoImpl Provides a HashMap implementation of POSInfo.
POSRequestImpl Base implementation of the POSRequest interface.
POSResultImpl Base implementation of the POSResult interface.
POSStatus Contains the status of the POSProvider.
ScannedItemIdentifier Provides a default implementation of an item identifier.
 

Exception Summary
ApplicationException An ApplicationException is thrown when the point-of-sale system encounters an error attempting to process a request from the client.
POSException POSException is the superclass of exceptions generated by operations performed on the point-of-sale system.
ProviderStateException A ProviderStateException is thrown when a request is made to perform a new request while the POSProvider is attempting error recovery or cleanup from a failed transaction.
RecoveryException A RecoveryException is thrown when a request is made to perform a new request while the POSProvider is attempting error recovery or cleanup from a failed transaction.
RequestException A RequestException indicates that a POSRequest has invalid or missing attributes.
TenderException A TenderException is generated when the request to tender payment fails to complete successfully on the point-of-sale system.
TimeoutException A TimeoutException is generated when the timeout value specified by the client expires before the requested point-of-sale operation has completed.
TransactionInProgressException A TransactionInProgressException is thrown when a request is made to start a new transaction or perform a new request while a Transaction is active.
TransactionStateException A TransactionStateException is thrown when a request is made to perform an action on a Transaction that is not in the proper state.
 

Package com.ibm.retail.saf.provider Description

Provides client interface for sending requests to a point-of-sale system.

The provider package includes POSProvider which defines an interface for sending requests to a point-of-sale system.

The POSProvider API includes a basic set of operations to perform the tasks required for order processing through the point-of-sale system.

The POSProvider uses POSRequest objects to contain the client input needed to process a request. POSRequest objects are extensible container objects that are passed to the point-of-sale system. They are extended to provide the point-of-sale system input needed to complete a specific POS operation. For example, a request to obtain unit prices utilizes a PriceRequest object as input to the getItemPrices method call.

Results from a point-of-sale operation are returned to the client in a POSResult object. These objects are similar to the POSRequest objects and provide a flexible means of returning information from the point-of-sale to the client application. Extensions are provided to define specialized interfaces for a request. For example, pricing results are returned in a PriceResult object.

Object creation for the POSProvider is provided through a factory interface. The POSProviderFactory provides the interface to instantiate instances of the POSProvider and the objects required to create and process a request through the POSProvider interface.