com.ibm.retail.AEF.event
Interface CouponEvent

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

public interface CouponEvent
extends LineItemEvent

A CouponEvent is generated when a coupon is applied to an item or transaction. A coupon may be applied by scanning a manufacturer or store coupon, or it may be applied automatically through a loyalty program.


Method Summary
 int getAgeRestriction()
          Returns the age restriction in years for an age restricted item.
 java.lang.String getCouponType()
          Returns the coupon type.
 java.lang.String getDealPrice()
          Returns the deal price.
 int getDealQuantity()
          Returns the item deal quantity.
 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 getManufacturerNumber()
          Returns the manufacturer's number for the coupon.
 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.util.Collection getRestrictedPeriods()
          Returns a list of restricted/unrestricted time periods for the item.
 java.lang.String getUnitPrice()
          Returns the coupon unit price (without currency symbol).
 java.lang.String getValue()
          Returns the extended value of the coupon.
 java.lang.String getWeight()
          Returns the item sale weight for an item sold by weight (e.g., produce).
 boolean isItemRepeatAllowed()
          Indicates whether item repeat is allowed for this item.
 boolean isTimeRestricted()
          Indicates whether the item is time restricted.
 boolean isWICEligible()
          Indicates whether the item is WIC eligible.
 boolean reducesFoodstampBalanceDue()
          Indicates whether the coupon reduces the foodstamp balance due.
 boolean reducesTaxDue()
          Indicates whether the coupon reduces the taxable transaction amount.
 
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
 

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

getCouponType

public java.lang.String getCouponType()
Returns the coupon type. Coupon types differentiate different forms of coupons. Eaxmples are "Store", "Manufacturer", and "Electronic".

Returns:
coupont type - returns null if the property is undefined

getUnitPrice

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

Returns:
formatted string representation of the item price per unit - 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

getValue

public java.lang.String getValue()
Returns the extended value of the coupon.

Returns:
string representation of the extended value. - returns null if the property is undefined

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

reducesFoodstampBalanceDue

public boolean reducesFoodstampBalanceDue()
                                   throws AEFException
Indicates whether the coupon reduces the foodstamp balance due.

Returns:
true if the coupon reduces the foodstamp balance due.
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

reducesTaxDue

public boolean reducesTaxDue()
                      throws AEFException
Indicates whether the coupon reduces the taxable transaction amount.

Returns:
true if the coupon reduces the taxable transaction amount.
Throws:
AEFException - Among the possible 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

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

getManufacturerNumber

public java.lang.String getManufacturerNumber()
Returns the manufacturer's number for the coupon.

Returns:
manufacturer number - returns null if the property is undefined


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