com.ibm.retail.AEF.automation
Interface ItemInfo

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

public interface ItemInfo
extends LineItemInfo

ItemInfo is an interface which encapsulates the item information for an item which is sold 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 item.
 int getAgeRestriction()
          Returns the age restriction (in years) for this item.
 java.lang.String getDealPrice()
          Returns the deal price for this item if the pricing method utilizes any kind of deal price.
 int getDealQuantity()
          Returns the deal quantity for this item if the pricing method utilizes any kind of deal price.
 java.lang.String getExtendedPrice()
          Get the extendedPrice
 com.ibm.retail.AEF.automation.ItemIdentifier getItemID()
          Gets the item identifier.
 java.lang.String getItemModifier()
          Gets the item modifier.
 java.lang.String getMultiPricingGroup()
          Returns the multi-pricing group for this item if the pricing method utilizes multi-pricing.
 java.lang.String getPricingMethod()
          Returns the pricing method for this item.
 int getQuantity()
          Get the quantity
 java.lang.String getReducedPrice()
          Returns the reduced price for this item if the pricing method utilizes a reduced price.
 java.lang.String getRegularPrice()
          Returns the regular price for this item.
 java.util.Collection getRestrictedPeriods()
          Returns the restricted time periods associated with this item.
 java.lang.String getUnitPrice()
          Get the unit price
 java.lang.String getWeight()
          Get the weight
 boolean isFoodstampEligible()
          Indicates whether the item is eligible for foodstamps.
 boolean isItemRepeatAllowed()
          Returns whether selling another item by using item repeat is allowed for this item.
 boolean isTaxable()
          Indicates whether the item is taxable.
 boolean isTimeRestricted()
          Is this item time restricted
 boolean isWICEligible()
          Indicates whether the item is eligible for WIC.
 void setAgeRestriction(int years)
          Sets the age restriction (in years) for this item.
 void setDealPrice(java.lang.String dealPrice)
          Set the deal price for this item.
 void setDealQuantity(int dealQuantity)
          Set the deal quantity for this item.
 void setExtendedPrice(java.lang.String value)
          Set the extendedPrice
 void setFoodstampEligible(boolean eligible)
          Sets whether the item is eligible for foodstamps.
 void setItemID(com.ibm.retail.AEF.automation.ItemIdentifier itemID)
          Sets the item identifier.
 void setItemModifier(java.lang.String itemModifier)
          Sets the item modifier.
 void setItemRepeatAllowed(boolean repeatAllowed)
          Set whether selling another item by using item repeat is allowed for this item.
 void setMultiPricingGroup(java.lang.String multiPricingGroup)
          Set the multi-pricing group for this item.
 void setPricingMethod(java.lang.String pricingMethod)
          Set the pricing method for this item.
 void setQuantity(int qty)
          Set the quantity
 void setReducedPrice(java.lang.String reducedPrice)
          Set the reduced price for this item.
 void setRegularPrice(java.lang.String price)
          Set the regular price for this item.
 void setRestrictedPeriods(java.util.Collection periods)
          Sets the restricted time periods associated with this item.
 void setTaxable(boolean taxable)
          Set whether the item is taxable.
 void setUnitPrice(java.lang.String value)
          Set the unit price
 void setWeight(java.lang.String weight)
          Set the weight
 void setWICEligible(boolean eligible)
          Sets whether the item is eligible for WIC.
 
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 item 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 item 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 item modifier. The modifier is optional application specific information.

Parameters:
itemModifier -

getItemModifier

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

Returns:
String

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

getExtendedPrice

public java.lang.String getExtendedPrice()
Get the extendedPrice

Returns:
extendedPrice

setExtendedPrice

public void setExtendedPrice(java.lang.String value)
Set the extendedPrice


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 purchase the item. 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 purchase the item. Use zero for no age restriction.

isFoodstampEligible

public boolean isFoodstampEligible()
Indicates whether the item is eligible for foodstamps.

Returns:
boolean True if eligible for food stamps.

setFoodstampEligible

public void setFoodstampEligible(boolean eligible)
Sets whether the item is eligible for foodstamps.


isWICEligible

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

Returns:
boolean True if eligible for WIC.

setWICEligible

public void setWICEligible(boolean eligible)
Sets whether the item is eligible for WIC.


isTimeRestricted

public boolean isTimeRestricted()
Is this item time restricted

Returns:
true if item is time restricted

getRestrictedPeriods

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

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

setRestrictedPeriods

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


addRestrictedPeriod

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


getDealQuantity

public int getDealQuantity()
Returns the deal quantity for this item 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 item.

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

getDealPrice

public java.lang.String getDealPrice()
Returns the deal price for this item 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 item.

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 item 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 item.

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

getMultiPricingGroup

public java.lang.String getMultiPricingGroup()
Returns the multi-pricing group for this item 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 item.

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

isItemRepeatAllowed

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

Returns:
boolean

setItemRepeatAllowed

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

Parameters:
repeatAllowed -

isTaxable

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

Returns:
boolean

setTaxable

public void setTaxable(boolean taxable)
Set whether the item is taxable.

Parameters:
taxable -

getPricingMethod

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

Returns:
String The pricing method.

setPricingMethod

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

Parameters:
pricingMethod -

getRegularPrice

public java.lang.String getRegularPrice()
Returns the regular price for this item.

Returns:
String The regular price for the item.

setRegularPrice

public void setRegularPrice(java.lang.String price)
Set the regular price for this item.

Parameters:
price - - The regular price for the item.


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