com.ibm.retail.AEF.automation
Interface LineItem
- All Superinterfaces:
- java.rmi.Remote
- All Known Subinterfaces:
- Coupon, CreditTender, Discount, Item, Points, Tender
- public interface LineItem
- extends java.rmi.Remote
LineItem is an interface which represents any of the line items in a transaction
(i.e., item, discount, tender, etc.).
Method Summary |
com.ibm.retail.AEF.automation.Identifier |
getIdentifier()
Returns the Identifier for this line item. |
com.ibm.retail.AEF.automation.LineItemInfo |
getInfo()
Returns the information for this line item. |
com.ibm.retail.AEF.session.AEFSession |
getSession()
Get the AEFSession object. |
void |
setIdentifier(com.ibm.retail.AEF.automation.Identifier identifier)
Sets the Identifier for this line item. |
void |
setInfo(com.ibm.retail.AEF.automation.LineItemInfo info)
Sets the information for this line item. |
void |
setSession(com.ibm.retail.AEF.session.AEFSession session)
Set the AEFSession object. |
java.util.ArrayList |
voidLineItem()
Voids the line item. |
voidLineItem
public java.util.ArrayList voidLineItem()
throws AEFException,
java.rmi.RemoteException
- Voids the line item. Use to remove a tender or item
from a transaction. Note that this method will attempt to void a line item
which matches the characteristics of this line item. There is no guarantee
that this actual line item is the one which will be voided. Note that this method will
always throw an AEFException with an error code of AEFConst.PROCEDURE_NOT_ALLOWED, AEFConst.NOT_IMPLEMENTED. It is up
to subclasses to provide working implementations of this method.
Currently, only LineItems which are Items may 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 "LineItem"
interface.
- Throws:
java.rmi.RemoteException
AEFException
- AEFException Error Codes:
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_TOTAL_TOO_LARGE
AEFConst.CONFIG_ERROR, AEFConst.FACTORY_ERROR
AEFConst.INVALID_ARGUMENT, AEFConst.EXTENDED_PRICE_TOO_LARGE
AEFConst.INVALID_MANAGER_OVERRIDE_NUMBER, AEFConst.NONE
AEFConst.KEYLOCK_ERROR, AEFConst.MANAGER_KEY_NOT_REMOVED
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.OUT_OF_MEMORY
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.PROCEDURE_NOT_ALLOWED, AEFConst.NOT_IMPLEMENTED
AEFConst.RETURN_COUPON_BEFORE_ITEM_VOID, AEFConst.NONE
AEFConst.SCALE_ERROR, AEFConst.NONE
AEFConst.VOID_MUST_MATCH_PREVIOUS, AEFConst.NONE
Common Errors
getInfo
public com.ibm.retail.AEF.automation.LineItemInfo getInfo()
throws java.rmi.RemoteException
- Returns the information for this line item.
- Returns:
- LineItemInfo
- Throws:
java.rmi.RemoteException
setInfo
public void setInfo(com.ibm.retail.AEF.automation.LineItemInfo info)
throws java.rmi.RemoteException
- Sets the information for this line item.
- 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
getIdentifier
public com.ibm.retail.AEF.automation.Identifier getIdentifier()
throws java.rmi.RemoteException
- Returns the Identifier for this line item.
- Returns:
- Identifier
- Throws:
java.rmi.RemoteException
setIdentifier
public void setIdentifier(com.ibm.retail.AEF.automation.Identifier identifier)
throws java.rmi.RemoteException
- Sets the Identifier for this line item.
- Throws:
java.rmi.RemoteException
Copyright © 2004 IBM. All Rights Reserved.
Generated: July 19 2004