com.ibm.retail.AEF.event
Interface ItemSalesEvent

All Superinterfaces:
LineItemEvent, POSAppEvent, POSAppEventElement, SAXElementHandler, java.io.Serializable

public interface ItemSalesEvent
extends LineItemEvent

An ItemSalesEvent is generated when an item is added or removed from a transaction. The ItemSalesEvent object contains details about the item sale.


Field Summary
static java.lang.String ITEM_SOLD
          item sold action identifier
 
Method Summary
 boolean enteredPriceUsed()
          Indicates if the item price was overridden, or the item was price required.
 int getAgeRestriction()
          Returns the age restriction in years for an age restricted item.
 java.lang.String getDealPrice()
          Returns the deal price.
 int getDealQuantity()
          Returns the item deal quantity.
 java.lang.String getExtendedPrice()
          Returns the extended price.
 java.lang.String getItemID()
          Returns the item code used to sell the item (e.g., the UPC number)
 java.lang.String getItemIDQualifier()
          Returns the item code qualifier.
 java.lang.String getLinkedItemID()
          Get the linked item code (if any).
 java.lang.String getLinkedItemIDQualifier()
          Get the linked item code qualifier.
 java.lang.String getMultiPricingGroup()
          Returns the multi pricing group used for deal pricing.
 java.lang.String getPricingMethod()
          Gets the pricing method for this item.
 int getQuantity()
          Returns the quantity sold.
 java.lang.String getReducedPrice()
          Returns the reduced price used for deal pricing.
 java.lang.String getRegularPrice()
          Returns the regular (non-discounted) price (without currency symbol).
 java.util.Collection getRestrictedPeriods()
          Returns a list of restricted/unrestricted time periods for the item.
 java.lang.String getReturnReason()
          Returns the return reason (for a returned item only.)
 java.lang.String getUnitPrice()
          Returns the item unit price (without currency symbol).
 java.lang.String getWeight()
          Returns the item sale weight for an item sold by weight (e.g., produce).
 boolean isFoodstampEligible()
          Indicates whether the item is foodstamp eligible.
 boolean isItemRepeatAllowed()
          Indicates whether item repeat is allowed for this item.
 boolean isReturn()
          Indicates whether the item is a return
 boolean isTaxable()
          Indicates whether the item is taxable.
 boolean isTimeRestricted()
          Indicates whether the item is time restricted.
 boolean isWICEligible()
          Indicates whether the item is WIC eligible.
 
Methods inherited from interface com.ibm.retail.AEF.event.LineItemEvent
getDescription, getItemModifier, getPrintLines, getRawPrintLines, isDeposit, isRefunded, isVoided
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEvent
getEventType, getPropertyChangeCategory, getTerminalNumber, setEventType, setTerminalNumber
 
Methods inherited from interface com.ibm.retail.AEF.event.POSAppEventElement
getBooleanPropertyValue, getData, getIntegerPropertyValue, getProperty, getPropertyEntries, setData, setProperty, toString
 
Methods inherited from interface com.ibm.retail.AEF.xml.SAXElementHandler
endElement, startElement
 

Field Detail

ITEM_SOLD

public static final java.lang.String ITEM_SOLD
item sold action identifier

See Also:
Constant Field Values
Method Detail

getItemID

public java.lang.String getItemID()
Returns the item code used to sell the item (e.g., the UPC number)

Returns:
item identifier - returns null if the property is undefined

getItemIDQualifier

public java.lang.String getItemIDQualifier()
Returns the item code qualifier. Indicates the format of the item code (may be scanned, keyed). For example, IBM 4690 Supermarket Application, the values may be:
  1. ScannedItemCode
  2. KeyedItemCode
  3. ItemLookupKeyed
  4. LinkedItemCode
  5. WandedItemCode

Returns:
item ID qualifier - returns null if the property is undefined

getUnitPrice

public java.lang.String getUnitPrice()
Returns the item unit price (without currency symbol).

Returns:
formatted string representation of the item price per unit - returns null if the property is undefined

getRegularPrice

public java.lang.String getRegularPrice()
Returns the regular (non-discounted) price (without currency symbol).

Returns:
formatted string representation of the item regular selling price - returns null if the property is undefined

getReturnReason

public java.lang.String getReturnReason()
Returns the return reason (for a returned item only.)

Returns:
reason code identifier - returns null if the property is undefined

getQuantity

public int getQuantity()
                throws AEFException
Returns the quantity sold.

Returns:
quantity sold as an int value
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getDealQuantity

public int getDealQuantity()
                    throws AEFException
Returns the item deal quantity. A deal quantity is used for items priced in multiples (e.g, 3 for 1.00)

Returns:
deal quantity as int value
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getWeight

public java.lang.String getWeight()
Returns the item sale weight for an item sold by weight (e.g., produce).

Returns:
item sale weight as a formatted string. - returns null if the property is undefined

getExtendedPrice

public java.lang.String getExtendedPrice()
Returns the extended price. The extended price is the amount charged for this item sale based on the quantity or weight.

Returns:
extended price as a formatted string. - returns null if the property is undefined

enteredPriceUsed

public boolean enteredPriceUsed()
                         throws AEFException
Indicates if the item price was overridden, or the item was price required.

Returns:
true if the price was entered by the operator.
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

getDealPrice

public java.lang.String getDealPrice()
Returns the deal price. Deal prices are defined for items sold as multiples (e.g., 3 for 1.00)

Returns:
string representation of the deal price - returns null if the property is undefined

getReducedPrice

public java.lang.String getReducedPrice()
Returns the reduced price used for deal pricing.

Returns:
string representation of the reduced price - returns null if the property is undefined

getMultiPricingGroup

public java.lang.String getMultiPricingGroup()
Returns the multi pricing group used for deal pricing.

Returns:
multi pricing group - returns null if the property is undefined

getAgeRestriction

public int getAgeRestriction()
                      throws AEFException
Returns the age restriction in years for an age restricted item.

Returns:
age restriction in years for an age restricted item
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isTimeRestricted

public boolean isTimeRestricted()
Indicates whether the item is time restricted.

Returns:
true if the item is time restricted

isFoodstampEligible

public boolean isFoodstampEligible()
                            throws AEFException
Indicates whether the item is foodstamp eligible.

Returns:
true if the item is foodstamp eligible
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isWICEligible

public boolean isWICEligible()
                      throws AEFException
Indicates whether the item is WIC eligible.

Returns:
true if the item is WIC eligible
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isItemRepeatAllowed

public boolean isItemRepeatAllowed()
                            throws AEFException
Indicates whether item repeat is allowed for this item. Item repeat is used by operators to indicate an item is sold multiple times without rescanning the item.

Returns:
true if item repeat is allowed
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isTaxable

public boolean isTaxable()
                  throws AEFException
Indicates whether the item is taxable.

Returns:
true if the item is taxable
Throws:
AEFException - Among the possible AEFException error codes are:
AEFConst.NO_SUCH_PROPERTY
AEFConst.INVALID_PROPERTY_VALUE

isReturn

public boolean isReturn()
                 throws AEFException
Indicates whether the item is a return

Returns:
boolean
Throws:
AEFException - if the property is undefined by the event
AEFException error codes are:
  • AEFConst.NO_SUCH_PROPERTY
  • AEFConst.INVALID_PROPERTY_VALUE

getPricingMethod

public java.lang.String getPricingMethod()
Gets the pricing method for this item.

Returns:
pricing method - returns null if the property is undefined

getLinkedItemID

public java.lang.String getLinkedItemID()
Get the linked item code (if any). Linked items are often used to associate coupons to an item or to define deals.

Returns:
linked item identifier. - returns null if the property is undefined

getLinkedItemIDQualifier

public java.lang.String getLinkedItemIDQualifier()
Get the linked item code qualifier. Indicates the data format of the item code (scanned, keyed,..).

Returns:
linked item id qualifier - returns null if the property is undefined

getRestrictedPeriods

public java.util.Collection getRestrictedPeriods()
Returns a list of restricted/unrestricted time periods for the item.

Returns:
Collection of TimeInterval objects or an empty collection.
See Also:
TimeInterval


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