com.ibm.retail.AEF.automation
Interface CouponInfo

All Superinterfaces:
BaseInfo, LineItemInfo, java.io.Serializable

public interface CouponInfo
extends LineItemInfo

CouponInfo is an interface which encapsulates the information for a coupon in a transaction.


Field Summary
static java.lang.String CLASS_KEY
           
 
Method Summary
 void addRestrictedPeriod(com.ibm.retail.AEF.event.TimeInterval period)
          Adds a restricted period for the coupon.
 int getAgeRestriction()
          Returns the age restriction (in years) for this item.
 java.lang.String getCouponType()
          Get the coupon type.
 java.lang.String getDealPrice()
          Returns the deal price for this coupon if the pricing method utilizes any kind of deal price.
 int getDealQuantity()
          Returns the deal quantity for this coupon if the pricing method utilizes any kind of deal price.
 com.ibm.retail.AEF.automation.ItemIdentifier getItemID()
          Gets the coupon identifier.
 java.lang.String getItemModifier()
          Gets the coupon modifier.
 java.lang.String getManufacturerNumber()
          Returns the manufacturer number for this coupon.
 java.lang.String getMultiPricingGroup()
          Returns the multi-pricing group for this coupon if the pricing method utilizes multi-pricing.
 java.lang.String getPricingMethod()
          Returns the pricing method for this coupon.
 int getQuantity()
          Get the quantity
 java.lang.String getReducedPrice()
          Returns the reduced price for this coupon if the pricing method utilizes a reduced price.
 java.util.Collection getRestrictedPeriods()
          Returns the restricted time periods associated with this coupon.
 java.lang.String getUnitPrice()
          Get the unit price
 java.lang.String getValue()
          Get the coupon value.
 java.lang.String getWeight()
          Get the weight
 boolean isItemRepeatAllowed()
          Returns whether redeeming another coupon by using item repeat is allowed for this coupon.
 boolean isTimeRestricted()
          Is this coupon time restricted
 boolean reducesFoodstampBalanceDue()
          Indicates whether the coupon reduces the foodstamp balance.
 boolean reducesTaxDue()
          Indicates whether the coupon reduces the transaction tax due.
 void setAgeRestriction(int years)
          Sets the age restriction (in years) for this item.
 void setCouponType(java.lang.String type)
          Set the coupon type
 void setDealPrice(java.lang.String dealPrice)
          Set the deal price for this coupon.
 void setDealQuantity(int dealQuantity)
          Set the deal quantity for this coupon.
 void setItemID(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
          Sets the coupon identifier.
 void setItemModifier(java.lang.String itemModifier)
          Sets the coupon modifier.
 void setItemRepeatAllowed(boolean repeatAllowed)
          Set whether redeeming another item by using item repeat is allowed for this coupon.
 void setManufacturerNumber(java.lang.String manufacturerNumber)
          Set the manufacturer number for this coupon.
 void setMultiPricingGroup(java.lang.String multiPricingGroup)
          Set the multi-pricing group for this coupon.
 void setPricingMethod(java.lang.String pricingMethod)
          Set the pricing method for this coupon.
 void setQuantity(int qty)
          Set the quantity
 void setReducedPrice(java.lang.String reducedPrice)
          Set the reduced price for this coupon.
 void setReducesFoodstampBalanceDue(boolean reduces)
          Sets whether the coupon reduces the foodstamp balance.
 void setReducesTaxDue(boolean reduces)
          Set whether the coupon reduces the transaction tax due.
 void setRestrictedPeriods(java.util.Collection periods)
          Sets the restricted time periods associated with this coupon.
 void setUnitPrice(java.lang.String value)
          Set the unit price
 void setValue(java.lang.String netValue)
          Set the coupon net value.
 void setWeight(java.lang.String weight)
          Set the weight
 
Methods inherited from interface com.ibm.retail.AEF.automation.LineItemInfo
addRawReceiptLine, addReceiptLine, getDescription, getRawReceiptLines, getReceiptLines, getTransaction, isDeposit, isRefunded, isVoided, setDeposit, setDescription, setRawReceiptLines, setReceiptLines, setRefunded, setTransaction, setVoided
 
Methods inherited from interface com.ibm.retail.AEF.automation.BaseInfo
getBooleanPropertyValue, getIntegerPropertyValue, getProperty, getPropertyEntries, setProperty, update
 

Field Detail

CLASS_KEY

public static final java.lang.String CLASS_KEY
See Also:
Constant Field Values
Method Detail

setItemID

public void setItemID(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
Sets the coupon identifier. This should be the scan label, velocity number, sku number, or department number.

Parameters:
itemID - The unique item identifier.

getItemID

public com.ibm.retail.AEF.automation.ItemIdentifier getItemID()
Gets the coupon identifier. This should be the upc code, velocity number, sku number, or department number.

Returns:
ItemIdentifier The item id.

setItemModifier

public void setItemModifier(java.lang.String itemModifier)
Sets the coupon modifier. The modifier is optional application specific information.

Parameters:
itemModifier -

getItemModifier

public java.lang.String getItemModifier()
Gets the coupon modifier. THe modifier is optional application specific information.

Returns:
String

getCouponType

public java.lang.String getCouponType()
Get the coupon type.

Returns:
String Coupon type = "Store", "Manufacturer", "Electronic", etc.

setCouponType

public void setCouponType(java.lang.String type)
Set the coupon type

Parameters:
type -

getUnitPrice

public java.lang.String getUnitPrice()
Get the unit price

Returns:
unit price

setUnitPrice

public void setUnitPrice(java.lang.String value)
Set the unit price


getQuantity

public int getQuantity()
Get the quantity

Returns:
quantity

setQuantity

public void setQuantity(int qty)
Set the quantity


getWeight

public java.lang.String getWeight()
Get the weight

Returns:
weight

setWeight

public void setWeight(java.lang.String weight)
Set the weight

Parameters:
weight -
Throws:
java.lang.NumberFormatException

getValue

public java.lang.String getValue()
Get the coupon value. This is the net value.

Returns:
coupon net value.

setValue

public void setValue(java.lang.String netValue)
Set the coupon net value.

Parameters:
netValue -

getAgeRestriction

public int getAgeRestriction()
Returns the age restriction (in years) for this item.

Returns:
int The number of years old the customer must be to redeem the coupon. Returns zero if there is no age restriction.

setAgeRestriction

public void setAgeRestriction(int years)
Sets the age restriction (in years) for this item.

Parameters:
years - The number of years old the customer must be to redeem the item. Use zero for no age restriction.

reducesFoodstampBalanceDue

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

Returns:
boolean True if coupon reduces foodstamp balance.

setReducesFoodstampBalanceDue

public void setReducesFoodstampBalanceDue(boolean reduces)
Sets whether the coupon reduces the foodstamp balance.


isTimeRestricted

public boolean isTimeRestricted()
Is this coupon time restricted

Returns:
true if coupon is time restricted

getRestrictedPeriods

public java.util.Collection getRestrictedPeriods()
Returns the restricted time periods associated with this coupon.

Returns:
Collection A collection of com.ibm.retail.AEF.event.TimeInterval objects, each representing a restricted time period for the coupon.

setRestrictedPeriods

public void setRestrictedPeriods(java.util.Collection periods)
Sets the restricted time periods associated with this coupon.


addRestrictedPeriod

public void addRestrictedPeriod(com.ibm.retail.AEF.event.TimeInterval period)
Adds a restricted period for the coupon.


getDealQuantity

public int getDealQuantity()
Returns the deal quantity for this coupon if the pricing method utilizes any kind of deal price.

Returns:
int The deal quantity.

setDealQuantity

public void setDealQuantity(int dealQuantity)
Set the deal quantity for this coupon.

Parameters:
dealQuantity - The quantity required for the deal pricing method.

getDealPrice

public java.lang.String getDealPrice()
Returns the deal price for this coupon if the pricing method utilizes any kind of deal price.

Returns:
String The deal price.

setDealPrice

public void setDealPrice(java.lang.String dealPrice)
Set the deal price for this coupon.

Parameters:
dealPrice - The deal price for the item if a deal pricing method applies.

getReducedPrice

public java.lang.String getReducedPrice()
Returns the reduced price for this coupon if the pricing method utilizes a reduced price.

Returns:
String The reduced price.

setReducedPrice

public void setReducedPrice(java.lang.String reducedPrice)
Set the reduced price for this coupon.

Parameters:
reducedPrice - The reduced price for the coupon if a reduced price pricing method applies.

getMultiPricingGroup

public java.lang.String getMultiPricingGroup()
Returns the multi-pricing group for this coupon if the pricing method utilizes multi-pricing.

Returns:
String The multi-pricing group.

setMultiPricingGroup

public void setMultiPricingGroup(java.lang.String multiPricingGroup)
Set the multi-pricing group for this coupon.

Parameters:
multiPricingGroup - The multi-pricing group for the coupon if the pricing method utilizes a multi-group pricing method.

isItemRepeatAllowed

public boolean isItemRepeatAllowed()
Returns whether redeeming another coupon by using item repeat is allowed for this coupon.

Returns:
boolean

setItemRepeatAllowed

public void setItemRepeatAllowed(boolean repeatAllowed)
Set whether redeeming another item by using item repeat is allowed for this coupon.

Parameters:
repeatAllowed -

reducesTaxDue

public boolean reducesTaxDue()
Indicates whether the coupon reduces the transaction tax due.

Returns:
boolean

setReducesTaxDue

public void setReducesTaxDue(boolean reduces)
Set whether the coupon reduces the transaction tax due.

Parameters:
reduces -

getPricingMethod

public java.lang.String getPricingMethod()
Returns the pricing method for this coupon.

Returns:
String The pricing method.

setPricingMethod

public void setPricingMethod(java.lang.String pricingMethod)
Set the pricing method for this coupon.

Parameters:
pricingMethod -

getManufacturerNumber

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

Returns:
String

setManufacturerNumber

public void setManufacturerNumber(java.lang.String manufacturerNumber)
Set the manufacturer number for this coupon.

Parameters:
manufacturerNumber -


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