com.ibm.retail.saf.provider
Interface TransactionRequest

All Superinterfaces:
POSInfo, POSRequest, java.io.Serializable
All Known Implementing Classes:
DefaultTransactionRequest

public interface TransactionRequest
extends POSRequest

Provides the item and customer information to be added to a point-of-sale transaction.

The request contains a collection of lineitems identifying the items and quantities to be purchased. The customer information provides the customer loyalty identifier needed to apply discounted pricing at the point-of-sale system.


Method Summary
 void addLineItem(com.ibm.retail.saf.provider.LineItem lineItem)
          Adds a LineItem to the request.
 java.lang.String getAlternateLoyaltyID()
          Gets the alternate loyalty or customer number defined for this transaction.
 java.lang.String getCustomerLoyaltyID()
          Gets the customer's loyalty identifier defined for this transaction.
 java.util.List getLineItemList()
          Gets the list of LineItems contained in the request.
 void removeLineItem(com.ibm.retail.saf.provider.LineItem lineItem)
          Removes a LineItem from the request.
 void setAlternateLoyaltyID(java.lang.String altID)
          Sets the alternate loyalty or customer number for this transaction.
 void setCustomerLoyaltyID(java.lang.String customerID)
          Sets a customer's loyalty identifier for this transaction.
 
Methods inherited from interface com.ibm.retail.saf.provider.POSRequest
getClientID, getRequestIdentifier
 
Methods inherited from interface com.ibm.retail.saf.provider.POSInfo
getExtendedAttribute, getExtendedAttributeNames, removeExtendedAttribute, setExtendedAttribute
 

Method Detail

getCustomerLoyaltyID

public java.lang.String getCustomerLoyaltyID()
Gets the customer's loyalty identifier defined for this transaction.

If no loyalty identifier is specified, the alternate loyalty identifier is used. If neither is specified, the transaction is processed without loyalty pricing.

Returns:
loyalty ID

getAlternateLoyaltyID

public java.lang.String getAlternateLoyaltyID()
Gets the alternate loyalty or customer number defined for this transaction. The alternate identifier is used as a substitute lookup to determine the customer loyalty number.


setCustomerLoyaltyID

public void setCustomerLoyaltyID(java.lang.String customerID)
Sets a customer's loyalty identifier for this transaction.

If no loyalty identifier is specified, the alternate loyalty identifier is used. If neither is specified, the transaction is processed without loyalty pricing.


setAlternateLoyaltyID

public void setAlternateLoyaltyID(java.lang.String altID)
Sets the alternate loyalty or customer number for this transaction. This identifier is used as a substitute lookup to determine the customer loyalty number.

Parameters:
altID - alternate loyalty ID

addLineItem

public void addLineItem(com.ibm.retail.saf.provider.LineItem lineItem)
Adds a LineItem to the request.

Duplicate lineitems in a list are allowed.


removeLineItem

public void removeLineItem(com.ibm.retail.saf.provider.LineItem lineItem)
Removes a LineItem from the request.


getLineItemList

public java.util.List getLineItemList()
Gets the list of LineItems contained in the request.

If no list exists, a null is returned.

Objects in the list are of type LineItem. A lineitem identifies the item and the quantity of the item to be sold by the point-of-sale system.

Returns:
a List of LineItems