com.ibm.retail.AEF.automation
Interface Transaction

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
SalesTransaction

public interface Transaction
extends java.rmi.Remote

Transaction is an interface for conducting a transaction on the POS application.


Method Summary
 void addLineItem(com.ibm.retail.AEF.automation.LineItem lineItem)
          Adds a LineItem instance to the transaction's collection.
 void addLineItemList(java.util.ArrayList list)
          Adds a collection of LineItem instances to the transaction's collection.
 boolean getIsActive()
          Indicates if the transaction is currently active (in progress).
 java.util.ArrayList getLineItemArrays()
          Gets an array.
 java.util.Iterator getLineItems()
          Gets the LineItems in the transaction.
 com.ibm.retail.AEF.session.AEFSession getSession()
          Get the AEFSession object.
 com.ibm.retail.AEF.automation.TransactionInfo getTransactionInfo()
          Returns the transaction information
 void setIsActive(boolean isActive)
          Sets the indicator determining if the transaciton is currently active (in progress).
 void setSession(com.ibm.retail.AEF.session.AEFSession session)
          Set the AEFSession object.
 void voidTransaction()
          Voids the transaction
 

Method Detail

getTransactionInfo

public com.ibm.retail.AEF.automation.TransactionInfo getTransactionInfo()
                                                                 throws java.rmi.RemoteException
Returns the transaction information

Returns:
TransactionInfo The transaction information.
Throws:
java.rmi.RemoteException

voidTransaction

public void voidTransaction()
                     throws AEFException,
                            java.rmi.RemoteException
Voids the transaction

Throws:
AEFException - Among the AEFException error codes are:
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_NOT_REMOVED
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.POS_APP_FAILURE, AEFConst.FILE_IO_ERROR
AEFConst.POS_APP_FAILURE, AEFConst.UNRECOGNIZED_PRINT_CHARACTERS
AEFConst.PRINTER_ERROR, AEFConst.COVER_OPEN
AEFConst.PRINTER_ERROR, AEFConst.NONE
AEFConst.PRINTER_ERROR, AEFConst.PAPER_LOW
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors
java.rmi.RemoteException

getLineItems

public java.util.Iterator getLineItems()
                                throws java.rmi.RemoteException
Gets the LineItems in the transaction.

Returns:
Iterator An iterator over the LineItems.
Throws:
java.rmi.RemoteException

getLineItemArrays

public java.util.ArrayList getLineItemArrays()
                                      throws java.rmi.RemoteException
Gets an array. Each element in the array is an array of linked LineItems in the transaction.

Returns:
ArrayList An array of LineItem arrays.
Throws:
java.rmi.RemoteException

addLineItem

public void addLineItem(com.ibm.retail.AEF.automation.LineItem lineItem)
                 throws java.rmi.RemoteException
Adds a LineItem instance to the transaction's collection.

Throws:
java.rmi.RemoteException

addLineItemList

public void addLineItemList(java.util.ArrayList list)
                     throws java.rmi.RemoteException
Adds a collection of LineItem instances to the transaction's collection.

Parameters:
list - An ArrayList of LineItems
Throws:
java.rmi.RemoteException

setSession

public void setSession(com.ibm.retail.AEF.session.AEFSession session)
                throws java.rmi.RemoteException
Set the AEFSession object.

Throws:
java.rmi.RemoteException

getSession

public com.ibm.retail.AEF.session.AEFSession getSession()
                                                 throws java.rmi.RemoteException
Get the AEFSession object.

Throws:
java.rmi.RemoteException

getIsActive

public boolean getIsActive()
                    throws java.rmi.RemoteException
Indicates if the transaction is currently active (in progress).

Returns:
boolean True if transaction is active.
Throws:
java.rmi.RemoteException

setIsActive

public void setIsActive(boolean isActive)
                 throws java.rmi.RemoteException
Sets the indicator determining if the transaciton is currently active (in progress).

Parameters:
isActive - True if transaction is currently active.
Throws:
java.rmi.RemoteException


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