com.ibm.retail.saf.provider
Interface Transaction

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
SalesTransaction
All Known Implementing Classes:
KioskSalesTransaction

public interface Transaction
extends java.rmi.Remote

Provides an interface to perform point-of-sale operations with an active POS transaction.

A Transaction is an object that provides access to an active transaction on the point-of-sale system. Transaction is the superinterface for transaction extensions that define modes of interaction with the point-of-sale transaction.

Transaction maintains state information which corresponds to the actual state of the active transaction on the point-of-sale system. Methods are provided to query the state of the object. A TransactionStateException is thrown if an attempt is made to perform an operation that is inconsistent with the current state of the transaction.


Method Summary
 com.ibm.retail.saf.provider.CashReceiptImage getCashReceiptImage()
          Get the image of the point-of-sale cash receipt produced by the transaction.
 com.ibm.retail.saf.provider.PaymentResult getPaymentResults()
          Returns the results from a payment operation on this transaction.
 com.ibm.retail.saf.provider.TransactionID getTransactionID()
          Get the transaction identifier.
 com.ibm.retail.saf.provider.TransactionTotals getTransactionTotals()
          Get the transaction totals.
 

Method Detail

getCashReceiptImage

public com.ibm.retail.saf.provider.CashReceiptImage getCashReceiptImage()
                                                                 throws java.rmi.RemoteException
Get the image of the point-of-sale cash receipt produced by the transaction.

The CashReceiptImage contains raw and formatted print lines that were sent to the point-of-sale receipt printer during the processing of the transaction.

Returns:
image of the POS cash receipt
java.rmi.RemoteException

getTransactionTotals

public com.ibm.retail.saf.provider.TransactionTotals getTransactionTotals()
                                                                   throws java.rmi.RemoteException
Get the transaction totals.

The TransactionTotals contain the totals produced by the processing of the transaction. This information includes the total amount and tax.

Returns:
totals for the transaction
java.rmi.RemoteException

getTransactionID

public com.ibm.retail.saf.provider.TransactionID getTransactionID()
                                                           throws java.rmi.RemoteException
Get the transaction identifier.

The TransactionID is used to identify the transaction.

Returns:
transaction ID
java.rmi.RemoteException

getPaymentResults

public com.ibm.retail.saf.provider.PaymentResult getPaymentResults()
                                                            throws java.rmi.RemoteException
Returns the results from a payment operation on this transaction.

Returns:
payment results from the transaction.
java.rmi.RemoteException