com.ibm.retail.AEF.automation
Interface SalesTransaction

All Superinterfaces:
java.rmi.Remote, Transaction

public interface SalesTransaction
extends Transaction

SalesTransaction is an interface representing a customer sales transaction on the POS application.


Method Summary
 com.ibm.retail.AEF.automation.Customer addAlternateCustomerID(java.lang.String custID)
          Add a loyalty customer (using alternate id) to the transaction.
 void addCustomerBirthdate(java.util.Date birthdate)
          Add the customer birthdate.
 com.ibm.retail.AEF.automation.Customer addCustomerLoyaltyID(java.lang.String custID)
          Add a loyalty customer to the transaction.
 java.util.ArrayList addItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
          Add an item to a sales transaction.
 java.util.ArrayList addItem(java.lang.String itemCode)
          Add an item to a sales transaction.
 java.util.ArrayList addTender(com.ibm.retail.AEF.automation.TenderIdentifier tenderIdentifier)
          Adds a tender to the transaction.
 java.util.ArrayList applyDelayedCoupons()
          Signals that any pending delayed coupons should be applied.
 com.ibm.retail.AEF.automation.Customer getCustomer()
          Get the customer object.
 com.ibm.retail.AEF.automation.TransactionTotals getTransactionTotals()
          Returns the TransactionTotals object.
 boolean hasItems()
          Indicates whether the transaction contains any unvoided items.
 java.util.ArrayList returnItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
          Return an item in a sales transaction.
 java.util.ArrayList returnItem(java.lang.String itemCode)
          Return an item in a sales transaction.
 void setCustomer(com.ibm.retail.AEF.automation.Customer value)
          Set the customer object.
 com.ibm.retail.AEF.automation.Transaction suspend()
          Suspends the transaction.
 com.ibm.retail.AEF.automation.Transaction suspend(java.lang.String reasonCode)
          Suspends the transaction.
 java.util.ArrayList voidItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
          Void an item in a sales transaction.
 java.util.ArrayList voidItem(java.lang.String itemCode)
          Void an item in a sales transaction.
 java.util.ArrayList voidLineItem(com.ibm.retail.AEF.automation.LineItem lineItem)
          Voids a line item (item or tender) from the transaction.
 java.util.ArrayList voidPreviousLineItem()
          Voids the previous line item (item or tender).
 
Methods inherited from interface com.ibm.retail.AEF.automation.Transaction
addLineItem, addLineItemList, getIsActive, getLineItemArrays, getLineItems, getSession, getTransactionInfo, setIsActive, setSession, voidTransaction
 

Method Detail

getTransactionTotals

public com.ibm.retail.AEF.automation.TransactionTotals getTransactionTotals()
                                                                     throws java.rmi.RemoteException
Returns the TransactionTotals object.

Returns:
TransactionTotals
Throws:
java.rmi.RemoteException

addCustomerBirthdate

public void addCustomerBirthdate(java.util.Date birthdate)
                          throws java.rmi.RemoteException
Add the customer birthdate.

Throws:
java.rmi.RemoteException

addCustomerLoyaltyID

public com.ibm.retail.AEF.automation.Customer addCustomerLoyaltyID(java.lang.String custID)
                                                            throws AEFException,
                                                                   java.rmi.RemoteException
Add a loyalty customer to the transaction.

Action ID = CustomerEntryAction

Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.DAILY_LOYALTY_CARD_USAGE_LIMIT
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.NONE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.LOYALTY_CARD_EXPIRED, AEFConst.NONE
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
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.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

addAlternateCustomerID

public com.ibm.retail.AEF.automation.Customer addAlternateCustomerID(java.lang.String custID)
                                                              throws AEFException,
                                                                     java.rmi.RemoteException
Add a loyalty customer (using alternate id) to the transaction.

Action ID = CustomerEntryAction

Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.DAILY_LOYALTY_CARD_USAGE_LIMIT
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.NONE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.LOYALTY_CARD_EXPIRED, AEFConst.NONE
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
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.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.UNSUPPORTED_OPERATION, AEFConst.NONE
Common Errors

addItem

public java.util.ArrayList addItem(java.lang.String itemCode)
                            throws AEFException,
                                   java.rmi.RemoteException
Add an item to a sales transaction.

Action ID = ItemEntryAction

Parameters:
itemCode - The item code as an operator would key it.
Returns:
ArrayList An array of one or more line items which were added as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.AGE_RESTRICTED_ITEM, AEFConst.NONE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.LOYALTY_POINTS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.MAX_NUMBER_OF_ITEMS
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NUMBER_OF_COUPONS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.COUPON_EXPIRED, AEFConst.NONE
AEFConst.COUPON_VALUE_EXCEEDS_ITEM_VALUE, AEFConst.NONE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.ITEM_NOT_FOR_SALE, AEFConst.NONE
AEFConst.ITEM_NOT_FOUND, AEFConst.NONE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.NO_ITEM_MATCH_FOR_COUPON, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYALTY_COUPON_NOT_APPLICABLE_TO_CUSTOMER_STATUS_LEVEL
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYALTY_NUMBER_REQUIRED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.MINIMUM_SALE_NOT_SATISFIED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.REWEIGH_ITEM
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

addItem

public java.util.ArrayList addItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
                            throws AEFException,
                                   java.rmi.RemoteException
Add an item to a sales transaction.

Action ID = ItemEntryAction

Parameters:
itemID - A unique identifier for the item to be added.
Returns:
ArrayList An array of one or more line items which were added as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.AGE_RESTRICTED_ITEM, AEFConst.NONE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.LOYALTY_POINTS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.MAX_NUMBER_OF_ITEMS
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NUMBER_OF_COUPONS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.COUPON_EXPIRED, AEFConst.NONE
AEFConst.COUPON_VALUE_EXCEEDS_ITEM_VALUE, AEFConst.NONE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.EXTENDED_PRICE_TOO_LARGE
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_AMOUNT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEPARTMENT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_ITEM_IDENTIFIER_TYPE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_WEIGHT
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.PRICE_AND_DEAL_PRICE_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_OR_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.WEIGHT_AND_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.ITEM_NOT_FOR_SALE, AEFConst.NONE
AEFConst.ITEM_NOT_FOUND, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.NO_ITEM_MATCH_FOR_COUPON, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYALTY_COUPON_NOT_APPLICABLE_TO_CUSTOMER_STATUS_LEVEL
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYALTY_NUMBER_REQUIRED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.MINIMUM_SALE_NOT_SATISFIED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.SCALE_ERROR, AEFConst.ITEM_IS_ON_THE_SCALE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.REWEIGH_ITEM
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

voidItem

public java.util.ArrayList voidItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
                             throws AEFException,
                                    java.rmi.RemoteException
Void an item in a sales transaction.

Action ID = ItemVoidAction

Parameters:
itemID - A unique identifier for the item to be voided.
Returns:
ArrayList An array of one or more line items which were voided as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.FOODSTAMP_TENDER_IN_EXCESS_OF_FOODSTAMP_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.EXTENDED_PRICE_TOO_LARGE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_AMOUNT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEPARTMENT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_ITEM_IDENTIFIER_TYPE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_WEIGHT
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_OR_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.PRICE_AND_DEAL_PRICE_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.WEIGHT_AND_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.ITEM_NOT_FOUND, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.NOT_APPROVED_BY_PAYMENT_SYSTEM
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.RETURN_COUPON_BEFORE_ITEM_VOID, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.ITEM_IS_ON_THE_SCALE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.VOID_MUST_MATCH_PREVIOUS, AEFConst.NONE
Common Errors

voidItem

public java.util.ArrayList voidItem(java.lang.String itemCode)
                             throws AEFException,
                                    java.rmi.RemoteException
Void an item in a sales transaction.

Action ID = ItemVoidAction

Parameters:
itemCode - The item code as an operator would key it.
Returns:
ArrayList An array of one or more line items which were voided as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.FOODSTAMP_TENDER_IN_EXCESS_OF_FOODSTAMP_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.NOT_APPROVED_BY_PAYMENT_SYSTEM
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.RETURN_COUPON_BEFORE_ITEM_VOID, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.VOID_MUST_MATCH_PREVIOUS, AEFConst.NONE
Common Errors

returnItem

public java.util.ArrayList returnItem(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
                               throws AEFException,
                                      java.rmi.RemoteException
Return an item in a sales transaction.

Action ID = ItemReturnAction

Parameters:
itemID - A unique identifier for the item to be returned.
Returns:
ArrayList An array of one or more line items which were returned as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.DEPARTMENT_RETURN_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.COUPON_VALUE_EXCEEDS_ITEM_VALUE, AEFConst.NONE
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.DEAL_PRICE_AND_DEAL_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.EXTENDED_PRICE_TOO_LARGE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_AMOUNT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEAL_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_DEPARTMENT
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_ITEM_IDENTIFIER_TYPE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_PRICE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_QUANTITY
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_WEIGHT
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_OR_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.PRICE_AND_DEAL_PRICE_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_ARGUMENT, AEFConst.WEIGHT_AND_QUANTITY_MUTUALLY_EXCLUSIVE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.ITEM_NOT_FOR_SALE, AEFConst.NONE
AEFConst.ITEM_NOT_FOUND, AEFConst.NONE
AEFConst.ITEM_NOT_RETURNABLE, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.NO_ITEM_MATCH_FOR_COUPON, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.SCALE_ERROR, AEFConst.ITEM_IS_ON_THE_SCALE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.REWEIGH_ITEM
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

returnItem

public java.util.ArrayList returnItem(java.lang.String itemCode)
                               throws AEFException,
                                      java.rmi.RemoteException
Return an item in a sales transaction.

Action ID = ItemReturnAction

Parameters:
itemCode - The item code as an operator would key it.
Returns:
ArrayList An array of one or more line items which were returned as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.DEPARTMENT_RETURN_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.COUPON_VALUE_EXCEEDS_ITEM_VALUE, AEFConst.NONE
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_OR_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.ITEM_NOT_FOR_SALE, AEFConst.NONE
AEFConst.ITEM_NOT_FOUND, AEFConst.NONE
AEFConst.ITEM_NOT_RETURNABLE, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.NO_ITEM_MATCH_FOR_COUPON, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.SCALE_ERROR, AEFConst.NONE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

voidLineItem

public java.util.ArrayList voidLineItem(com.ibm.retail.AEF.automation.LineItem lineItem)
                                 throws AEFException,
                                        java.rmi.RemoteException
Voids a line item (item or tender) from the transaction.

Action ID = ItemVoidAction

Note: This method currently only supports voiding "items". All other type of LineItems will result in an AEFException being thrown with error codes of AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NOT_IMPLEMENTED.

Returns:
ArrayList An array of one or more line items which were voided as a result of the call. Actual items will implement the "LineItem" interface.
Throws:
java.rmi.RemoteException
AEFException - Among the possible error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.FOODSTAMP_TENDER_IN_EXCESS_OF_FOODSTAMP_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_CLASS_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_DEPARTMENT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_OR_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_PRICE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_QUANTITY_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_STOCK_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.ITEM_WEIGHT_REQUIRED
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.NOT_APPROVED_BY_PAYMENT_SYSTEM
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NOT_IMPLEMENTED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.VOID_MUST_MATCH_PREVIOUS, AEFConst.NONE
Common Errors

addTender

public java.util.ArrayList addTender(com.ibm.retail.AEF.automation.TenderIdentifier tenderIdentifier)
                              throws AEFException,
                                     java.rmi.RemoteException
Adds a tender to the transaction. The TenderIdentifier determines the type of tender and provides the necessary arguments.

Action ID = AddCreditTenderAction

Parameters:
tenderIdentifier - An object which determines the tender type, amount, and any additional required tender information. The TenderIdentifier must implement CreditIdentifer or MSRCreditIdentifier.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ACCOUNT_TENDER_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.CHANGE_AMOUNT_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.LOYALTY_POINTS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NUMBER_OF_COUPONS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NUMBER_OF_TENDERS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.STAND_IN_COUNT_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TENDER_AMOUNT_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TENDER_FLOOR_LIMIT
AEFConst.CONFIG_ERROR, AEFConst.NONE
AEFConst.CONFIG_ERROR, AEFConst.TAX_TABLE_NOT_FOUND
AEFConst.CONFIG_ERROR, AEFConst.UNDEFINED_TENDER_VARIETY
AEFConst.ENABLEMENT_ERROR, AEFConst.AUTHORIZATION_NUMBER_MISMATCH
AEFConst.INVALID_ARGUMENT, AEFConst.ACCOUNT_NUMBER_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.AMOUNT_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.AUTHORIZATION_CODE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.CREDIT_CARD_TYPE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.EXPIRATION_DATE_REQUIRED
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_ACCOUNT_NUMBER
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_AUTHORIZATION_CODE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_EXPIRY_DATE
AEFConst.INVALID_ARGUMENT, AEFConst.INVALID_TENDER_TYPE
AEFConst.INVALID_ARGUMENT, AEFConst.NONE
AEFConst.INVALID_ARGUMENT, AEFConst.TRACK_DATA_PROHIBITED
AEFConst.INVALID_ARGUMENT, AEFConst.TRACK_DATA_REQUIRED
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_SET_TO_DECODE
AEFConst.MSR_HOOK_SWIPE_ERROR, AEFConst.MSR_NOT_ENABLED
AEFConst.JAVA_POS_EXCEPTION, see exception cause() for actual javaPos exception
AEFConst.POS_APP_FAILURE, AEFConst.FILE_IO_ERROR
AEFConst.POS_APP_FAILURE, AEFConst.PAYMENT_SYSTEM_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.EXTERNAL_TENDER_AUTHORIZATION_SUSPENDED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYTALTY_COUPON_NOT_APPLICABLE_TO_CUSTOMER_STATUS_LEVEL
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NOT_IMPLEMENTED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TENDER_TYPE_NOT_ALLOWED
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.CALL_FOR_AUTHORIZATION
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.CNCELLED_BY_OPERATOR
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.CARD_EXPIRED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.CARD_TYPE_UNKNOWN
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.CREDIT_NOT_AVAILABLE
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.INVALID_CARD_DATA
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.LOYALTY_NUMBER_REQUIRED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.PAYMENT_SYSTEM_OFFLINE
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.PIN_PAD_REQUIRED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.RISK_1
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.RISK_2
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.RISK_3
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.RISK_4
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.SERVICER_CLOSED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.TENDER_EXPIRED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.TENDER_NOT_AUTHORIZED
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.TOO_LONG_IN_STAND_IN
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.UNKNOWN_SERVICER
AEFConst.TENDER_NOT_ACCEPTED, AEFConst.VERIFICATION_TIMEOUT
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.VERIFY_SIGNATURE, AEFConst.NONE
Common Errors

voidPreviousLineItem

public java.util.ArrayList voidPreviousLineItem()
                                         throws AEFException,
                                                java.rmi.RemoteException
Voids the previous line item (item or tender).

Action ID = CancelPreviousEntryAction

Returns:
ArrayList An array of one or more line items which were voided as a result of the call. Actual items will implement the "Item" interface. Additional Items or Coupons may be included in the array because of linked items.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NEGATIVE_TRANSACTION_BALANCE
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_TOTALS_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
AEFConst.POS_APP_FAILURE, AEFConst.INVALID_APPLICATION_DATA
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.TRANSACTION_NOT_ACTIVE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
AEFConst.VOID_MUST_MATCH_PREVIOUS, AEFConst.NONE
Common Errors

suspend

public com.ibm.retail.AEF.automation.Transaction suspend(java.lang.String reasonCode)
                                                  throws AEFException,
                                                         java.rmi.RemoteException
Suspends the transaction.

Action ID = SuspendTransaction

Returns:
Transaction The suspended transaction.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.REASON_CODE_PROHIBITED
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
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.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

suspend

public com.ibm.retail.AEF.automation.Transaction suspend()
                                                  throws AEFException,
                                                         java.rmi.RemoteException
Suspends the transaction. Find out if this is the current transaction. If so then tell the automation provider to suspend it. Otherwise throw an exception.

Action ID = SuspendTransaction

Returns:
Transaction The suspended transaction.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
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.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NONE
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

setCustomer

public void setCustomer(com.ibm.retail.AEF.automation.Customer value)
                 throws java.rmi.RemoteException
Set the customer object.

Throws:
java.rmi.RemoteException

getCustomer

public com.ibm.retail.AEF.automation.Customer getCustomer()
                                                   throws java.rmi.RemoteException
Get the customer object.

Throws:
java.rmi.RemoteException

applyDelayedCoupons

public java.util.ArrayList applyDelayedCoupons()
                                        throws AEFException,
                                               java.rmi.RemoteException
Signals that any pending delayed coupons should be applied. Note that this action is typically only allowed once during any transaction.

Action ID = ApplyDelayedCouponsAction

Returns:
An ArrayList of LineItems. The line items will contain any delayed coupons that are applied as a result of this call.
Throws:
java.rmi.RemoteException
AEFException - Among the possible AEFException error codes are:
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.ITEM_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.LOYALTY_POINTS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.NUMBER_OF_COUPONS_LIMIT
AEFConst.APPLICATION_LIMIT_EXCEEDED, AEFConst.TRANSACTION_LIMIT
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_REQUIRED
AEFConst.MANAGER_OVERRIDE_REQUIRED, AEFConst.NONE
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.HOST_REQUEST_PENDING
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.LOYALTY_COUPON_NOT_APPLICABLE_TO_CUSTOMER_STATUS_LEVEL
AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.TRANSACTION_NOT_ACTIVE
AEFConst.UNCHECKED_EXCEPTION, AEFConst.NONE
Common Errors

hasItems

public boolean hasItems()
                 throws java.rmi.RemoteException
Indicates whether the transaction contains any unvoided items.

Returns:
boolean
Throws:
java.rmi.RemoteException


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