com.ibm.commerce.tools.epromotion.implementations

Class OrderLevelFreeGift

java.lang.Object

com.ibm.commerce.tools.epromotion.RLPromotion

com.ibm.commerce.tools.epromotion.RLOrderLevelPromotion

com.ibm.commerce.tools.epromotion.implementations.OrderLevelFreeGift

All Implemented Interfaces:

RLConstants

public class OrderLevelFreeGift
extends RLOrderLevelPromotion

This class presents specific details of an Order Level promotion of type OrderLevelFreeGift. This type represents giving an item free if the purchase is over a certain amount.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The copyright information.

Fields inherited from interface com.ibm.commerce.tools.epromotion.RLConstants

CATEGORY_LEVEL_DISPLAY_FLAG, DISCOUNT_DEPLOYMENT, EC_CALCODE_ID, EC_CODE, EC_DESCRIPTION, EC_DISCOUNTNAME, EC_ENDDATE, EC_ORDERBY, EC_PRIORITY, EC_RANGE_MAX, EC_STARTDATE, EC_STATE, EC_STATUS, ERROR_PROMOTION_DELETED_DUPLICATE_CODE, ERROR_PROMOTION_DUPLICATE_CODE, ERROR_PROMOTION_NOT_SAVED, ERROR_PROMOTION_NOT_UPDATED, MSG_PROMOTION_SAVED, MSG_PROMOTION_UPDATED, NEVER_EXPIRE, ORDER_LEVEL_DISPLAY_FLAG, PRODUCT_LEVEL_DISPLAY_FLAG, REST_OF_TIMESTRING, RLPRODPROMO_TYPEALIAS, RLPROMOTION, RLPROMOTION_ADJUSTMENT_TYPE, RLPROMOTION_ASSIGNEDSEGMENTIDS, RLPROMOTION_ASSIGNEDSEGMENTS, RLPROMOTION_CATEGORYLEVELBUYXGETYFREE, RLPROMOTION_CATEGORYLEVELPERCENTDISCOUNT, RLPROMOTION_CATEGORYLEVELPERITEMVALUEDISCOUNT, RLPROMOTION_CATEGORYLEVELSAMEITEMPERCENTDISCOUNT, RLPROMOTION_CATEGORYLEVELVALUEDISCOUNT, RLPROMOTION_CATENTRY_ID, RLPROMOTION_CATENTRY_TYPE, RLPROMOTION_CATGROUP_CODE, RLPROMOTION_CATGROUP_ID, RLPROMOTION_CODE_REQUIRED, RLPROMOTION_COUPON_EFFECTIVE_DAYS, RLPROMOTION_COUPON_EXPIRATION_DAYS, RLPROMOTION_CURRENCY, RLPROMOTION_DATERANGED, RLPROMOTION_DAYSINWEEK, RLPROMOTION_DESCRIPTION, RLPROMOTION_DESCRIPTION_LONG_NL, RLPROMOTION_DESCRIPTION_NL, RLPROMOTION_DISCOUNT_ITEM_QTY, RLPROMOTION_DISCOUNT_ITEM_SKU, RLPROMOTION_DISPLAY_LEVEL, RLPROMOTION_ENDDAY, RLPROMOTION_ENDHOUR, RLPROMOTION_ENDMONTH, RLPROMOTION_ENDYEAR, RLPROMOTION_EXCLUSIVENESS, RLPROMOTION_FRIDAY, RLPROMOTION_GROUP_NAME, RLPROMOTION_GWP_CATENTRY_ID, RLPROMOTION_INCOMBINATIONWITH, RLPROMOTION_ISCOUPON, RLPROMOTION_ISEVERYDAYFLAG, RLPROMOTION_ITEMLEVELBUYXGETYFREE, RLPROMOTION_ITEMLEVELPERCENTDISCOUNT, RLPROMOTION_ITEMLEVELPERITEMVALUEDISCOUNT, RLPROMOTION_ITEMLEVELSAMEITEMPERCENTDISCOUNT, RLPROMOTION_ITEMLEVELVALUEDISCOUNT, RLPROMOTION_LAST_UPDATE_TIME, RLPROMOTION_LAST_UPDATE_USER, RLPROMOTION_LIST_ALL, RLPROMOTION_LIST_ORDERLEVEL, RLPROMOTION_LIST_PRODUCTLEVEL, RLPROMOTION_MAX_DISCOUNT_ITEM_QTY, RLPROMOTION_MERCHANDISE_TYPE, RLPROMOTION_MONDAY, RLPROMOTION_NAME, RLPROMOTION_ORDER_GROUP, RLPROMOTION_ORDERLEVELFIXEDSHIPPINGDISCOUNT, RLPROMOTION_ORDERLEVELFREEGIFT, RLPROMOTION_ORDERLEVELPERCENTDISCOUNT, RLPROMOTION_ORDERLEVELVALUEDISCOUNT, RLPROMOTION_ORIGINAL_STORE, RLPROMOTION_PER_ORDER_LIMIT, RLPROMOTION_PER_SHOPPER_LIMIT, RLPROMOTION_PRIORITY, RLPROMOTION_PROD_SEARCH_PAGE, RLPROMOTION_PRODUCT_GROUP, RLPROMOTION_PRODUCT_SKU, RLPROMOTION_PRODUCTLEVELBUYXGETYFREE, RLPROMOTION_PRODUCTLEVELPERCENTDISCOUNT, RLPROMOTION_PRODUCTLEVELPERITEMVALUEDISCOUNT, RLPROMOTION_PRODUCTLEVELSAMEITEMPERCENTDISCOUNT, RLPROMOTION_PRODUCTLEVELVALUEDISCOUNT, RLPROMOTION_PROMOGROUP, RLPROMOTION_PROMOTION_CODE, RLPROMOTION_RANGES, RLPROMOTION_RELATED_STORE, RLPROMOTION_REQUIRED_QTY, RLPROMOTION_RESOURCES, RLPROMOTION_REVISION, RLPROMOTION_SATURDAY, RLPROMOTION_SHIPMODEID, RLPROMOTION_SHIPPING_GROUP, RLPROMOTION_STARTDAY, RLPROMOTION_STARTHOUR, RLPROMOTION_STARTMONTH, RLPROMOTION_STARTYEAR, RLPROMOTION_STATUS, RLPROMOTION_SUNDAY, RLPROMOTION_TARGETSALES, RLPROMOTION_THURSDAY, RLPROMOTION_TIMERANGED, RLPROMOTION_TOTAL_LIMIT, RLPROMOTION_TUESDAY, RLPROMOTION_TYPE, RLPROMOTION_VALIDFORALLCUSTOMERS, RLPROMOTION_VALUE, RLPROMOTION_VALUES, RLPROMOTION_VERSION, RLPROMOTION_WEDNESDAY, ZERO_STRING

Constructor Summary

Constructors

Constructor and Description
OrderLevelFreeGift() OrderLevelFreeGift Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	generatePromotionSpecificRuleXML() Generate the specific rule XML as a part of Domain XML (Promotion Object).
java.lang.String	getFreeItemCatalogEntrySKU() Gets the SKU of the freebie item.
void	populatePromotionSpecificDataFrom(java.util.Map h) This Method is used to populate the RLPromotion attribute.
void	populatePromotionSpecificDataFrom(java.lang.String xmlString) Populate the specific data from XML String.
void	setFreeItemCatalogEntrySKU(java.lang.String newFreeItemCatalogEntrySKU) Sets the freebie item SKU.

Methods inherited from class com.ibm.commerce.tools.epromotion.RLOrderLevelPromotion

generatePromotionLevelSpecificRuleXML, getPromotionDisplayLevel, getRanges, getValues, isInCombinationWithProductLevelPromotion, populatePromotionLevelSpecificDataFrom, populatePromotionLevelSpecificDataFrom, setRanges, setValues

Methods inherited from class com.ibm.commerce.tools.epromotion.RLPromotion

fromXML, getAllowCouponTransfer, getAssignedSegmentIds, getAssignedSegments, getCodeRequired, getCouponEffectiveDays, getCouponExpirationDays, getCurrency, getDateRanged, getDayInWeek, getDaysInWeek, getDescription, getDescriptionLongNL, getDescriptionNL, getEndTimeStamp, getExclusive, getGroupName, getIsAdjustmentBasedOnStandardOfferPrice, getIsCoupon, getLanguageId, getLastUpdate, getLastUpdateUserId, getName, getPerOrderLimit, getPerShopperLimit, getPriority, getPromotionCode, getRevision, getRLPromotionType, getStartTimeStamp, getStatus, getStoreId, getTargetSalesFigure, getTimeRanged, getTotalLimit, getValidForAllCustomers, getVersion, setAllowCouponTransfer, setAssignedSegmentIds, setAssignedSegments, setCodeRequired, setCouponEffectiveDays, setCouponExpirationDays, setCurrency, setDaysInWeek, setDescription, setDescriptionLongNL, setDescriptionNL, setEndTimeStamp, setExclusive, setGroupName, setIsCoupon, setLanguageId, setLastUpdate, setLastUpdateUserId, setName, setPerOrderLimit, setPerShopperLimit, setPriority, setPromotionCode, setRevision, setRLPromotionType, setStartTimeStamp, setStatus, setStoreId, setTargetSalesFigure, setTotalLimit, setVersion, toXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The copyright information.

See Also:

Constant Field Values

Constructor Detail

OrderLevelFreeGift

public OrderLevelFreeGift()

OrderLevelFreeGift Constructor.

Method Detail

getFreeItemCatalogEntrySKU

public java.lang.String getFreeItemCatalogEntrySKU()

Gets the SKU of the freebie item.

Returns:

String of the SKU of the freebie item.

setFreeItemCatalogEntrySKU

public void setFreeItemCatalogEntrySKU(java.lang.String newFreeItemCatalogEntrySKU)

Sets the freebie item SKU.

Parameters:

String - of the freebie item SKU.

generatePromotionSpecificRuleXML

public java.lang.String generatePromotionSpecificRuleXML()

Generate the specific rule XML as a part of Domain XML (Promotion Object).

Returns:

java.lang.String of XML representing the rule for promotion of free gift.

populatePromotionSpecificDataFrom

public void populatePromotionSpecificDataFrom(java.lang.String xmlString)

Populate the specific data from XML String.

Parameters:

xmlString - java.lang.String containg promotion data.

populatePromotionSpecificDataFrom

public void populatePromotionSpecificDataFrom(java.util.Map h)
                                       throws ParameterNotFoundException

This Method is used to populate the RLPromotion attribute.

Overrides:

populatePromotionSpecificDataFrom in class RLOrderLevelPromotion

Parameters:

h - java.util.Map containing RLPromotion attribute.

Throws:

ParameterNotFoundException - The exception description.