RLPromotion

java.lang.Object
- com.ibm.commerce.tools.epromotion.RLPromotion

All Implemented Interfaces:

RLConstants

Direct Known Subclasses:

RLItemLevelPromotion, RLOrderLevelPromotion, RLProductLevelPromotion
```
public abstract class RLPromotion
extends java.lang.Object
implements RLConstants
```
The promotion class is an object used to hold all of the information associated with a particular promotion created in the User Interface. It is intended to be extended by customers who wish to create and support their own promotion types.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.
- 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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

RLPromotion()
Default constructor of this class.

Constructors
Constructor and Description
`RLPromotion()` Default constructor of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`fromCustomXML(java.lang.String xml)` Populate customized fields in this promotion object.
`protected abstract void`	`fromSpecificXML(java.lang.String xml)` Populate this promotion object specific fields from a non-Blaze XML representation.
`void`	`fromXML(java.lang.String xml)` Populate the promotion object from a nonBlaze XML representation.
`boolean`	`getAllowCouponTransfer()` Gets true only if this is a coupon promotion and allow this coupon promotion to be transferred.
`java.util.Vector`	`getAssignedSegmentIds()` Get the assignedSegmentIds
`java.util.Vector`	`getAssignedSegments()` Get the assignedSegments.
`boolean`	`getCodeRequired()` Check if the promotion code is required in this promotion.
`int`	`getCouponEffectiveDays()` Gets the coupon effective days.
`int`	`getCouponExpirationDays()` Gets the coupon expiration days.
`java.lang.String`	`getCurrency()` Get the currency.
`boolean`	`getDateRanged()` Check if the promotion is scheduled by date.
`java.util.Vector`	`getDayInWeek()` Get the daysInWeek.
`java.util.Vector`	`getDaysInWeek()` Gets the daysInWeek.
`java.lang.String`	`getDescription()` Get the description.
`java.lang.String`	`getDescriptionLongNL()` Get the customers viewable long description.
`java.lang.String`	`getDescriptionNL()` Return the customers viewable description.
`java.sql.Timestamp`	`getEndTimeStamp()` Get the promotion end timestamp.
`int`	`getExclusive()` Gets the exclusiveness of current RLPromotion object.
`java.lang.String`	`getGroupName()` Gets the group name of current RLPromotion object.
`boolean`	`getIsAdjustmentBasedOnStandardOfferPrice()` Gets true only if adjustment is based on standard offer price.
`boolean`	`getIsCoupon()` Check if the current RLPromotion is a coupon promotion.
`java.lang.String`	`getLanguageId()` Gets the language ID of current RLPromotion object description.
`java.sql.Timestamp`	`getLastUpdate()` Gets the timestamp when the current RLPromotion object was updated at last.
`java.lang.String`	`getLastUpdateUserId()` Gets the user logon ID who is the last one to update the current RLPromotion object.
`java.lang.String`	`getName()` Get the promotion name.
`int`	`getPerOrderLimit()` Gets the promotion applicable limit per order.
`int`	`getPerShopperLimit()` Gets the promotion applicable limit per customer.
`int`	`getPriority()` Get the promotion priority.
`java.lang.String`	`getPromotionCode()` Gets the promotion code of current RLPromotion object.
`abstract java.lang.Integer`	`getPromotionDisplayLevel()` Get the promotion display level.
`int`	`getRevision()` Gets the revision of current RLPromotion object.
`java.lang.String`	`getRLPromotionType()` Get promotion type.
`java.sql.Timestamp`	`getStartTimeStamp()` Get promotion start timestamp.
`int`	`getStatus()` Get promotion status.
`java.lang.String`	`getStoreId()` Gets the store ID of current RLPromotion object.
`java.lang.String`	`getTargetSalesFigure()` Get promotion target sales.
`boolean`	`getTimeRanged()` Check if the promotion is scheduled by time.
`int`	`getTotalLimit()` Gets the promotion total applicable limit.
`boolean`	`getValidForAllCustomers()` Check if the promotion is valid for all customers.
`int`	`getVersion()` Gets the version of current RLPromotion object.
`protected void`	`populateFrom(java.util.Map h)` PopulateFrom is used to tell an RLPromotion to populate itself from a Map.
`abstract void`	`populatePromotionLevelSpecificDataFrom(java.util.Map h)` Populate promotion level specific data for itself from a Map.
`abstract void`	`populatePromotionSpecificDataFrom(java.util.Map h)` Populate promotion specific data for itself from a Map.
`void`	`setAllowCouponTransfer(boolean newAllowCouponTransfer)` Sets true only if this is a coupon promotion and allow this coupon promotion to be transferred.
`void`	`setAssignedSegmentIds(java.util.Vector newAssignedSegmentIds)` Sets the assignedSegmentIds
`void`	`setAssignedSegments(java.util.Vector newAssignedSegments)` Sets the assignedSegments.
`void`	`setCodeRequired(boolean newCodeRequired)` Sets the boolean value if the promotion code is required in this promotion.
`void`	`setCouponEffectiveDays(int newCouponEffectiveDays)` Sets the coupon effective days.
`void`	`setCouponExpirationDays(int newCouponExpirationDays)` Sets the coupon expiration days.
`void`	`setCurrency(java.lang.String newCurrency)` Sets the currency.
`void`	`setDaysInWeek(java.util.Vector newDaysInWeek)` Sets the days in week.
`void`	`setDescription(java.lang.String newDesc)` Because the description is stored in the CalcoDesc table, it has to be set outside of 'populate' method.
`void`	`setDescriptionLongNL(java.lang.String newDescriptionLongNL)` Because the NL-enabled long description is stored in the `CALCODEDSC` table, it has to be set outside of 'populate' method.
`void`	`setDescriptionNL(java.lang.String newDescNL)` Because the NL-enabled short description is stored in the `CALCODEDSC` table, it has to be set outside of 'populate' method.
`void`	`setEndTimeStamp(java.sql.Timestamp newEndTimeStamp)` Sets the endTimeStamp.
`void`	`setExclusive(int newExclusive)` Sets the exclusiveness of current RLPromotion object.
`void`	`setGroupName(java.lang.String newGroupName)` Sets the group name of current RLPromotion object.
`void`	`setIsCoupon(boolean newIsCoupon)` Sets true if the current RLPromotion is a coupon promotion, otherwise false.
`void`	`setLanguageId(java.lang.String newLanguageId)` Sets the language ID of current RLPromotion object description.
`void`	`setLastUpdate(java.sql.Timestamp newLastUpdate)` Sets the Timestamp when the current RLPromotion object was updated at last.
`void`	`setLastUpdateUserId(java.lang.String newLastUpdateUserId)` Sets the user logon ID who is the last one to update the current RLPromotion object.
`void`	`setName(java.lang.String newDiscountName)` Set the name of the Discount.
`void`	`setPerOrderLimit(int newPerOrderLimit)` Sets the promotion applicable limit per order.
`void`	`setPerShopperLimit(int newPerShopperLimit)` Sets the promotion applicable limit per customer.
`void`	`setPriority(int newPriority)` Sets the priority.
`void`	`setPromotionCode(java.lang.String newPromotionCode)` Sets the promotion code of current RLPromotion object.
`void`	`setRevision(int newRevision)` Sets the revision of current RLPromotion object.
`void`	`setRLPromotionType(java.lang.String newRlPromotionType)` Sets the rlPromotionType.
`void`	`setStartTimeStamp(java.sql.Timestamp newStartTimeStamp)` Sets the startTimeStamp.
`void`	`setStatus(int newStatus)` Sets the status.
`void`	`setStoreId(java.lang.String newStoreId)` Sets the store ID of current RLPromotion object.
`void`	`setTargetSalesFigure(java.lang.String newTargetSalesFigure)` targetSalesFigure is not stored in the XML string, it has to be set outside of 'populate' method.
`void`	`setTotalLimit(int newTotalLimit)` Sets the promotion total applicable limit.
`void`	`setVersion(int newVersion)` Sets the version of current RLPromotion object.
`protected java.lang.String`	`toCustomXML()` Generate the customizable condition XML representation.
`protected abstract java.lang.String`	`toSpecificXML()` Generate the specific part of non-Blaze XML representation.
`java.lang.String`	`toXML()` Generate the nonBlaze promotion XML representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RLPromotion
```
public RLPromotion()
```
    Default constructor of this class.
- Method Detail
  - toSpecificXML
```
protected abstract java.lang.String toSpecificXML()
```
    Generate the specific part of non-Blaze XML representation. This abstract method has to be implemented by each concrete promotion type.
    
    Returns:
    
    java.lang.String
  - fromSpecificXML
```
protected abstract void fromSpecificXML(java.lang.String xml)
```
    Populate this promotion object specific fields from a non-Blaze XML representation. This abstract method has to be implemented by each concrete promotion type.
    
    Parameters:
    
    String - XML
  - toCustomXML
```
protected java.lang.String toCustomXML()
```
    Generate the customizable condition XML representation. This method can be override by any child promotion object. Using for customization purpose.
    
    Returns:
    
    java.lang.String
  - fromCustomXML
```
protected void fromCustomXML(java.lang.String xml)
```
    Populate customized fields in this promotion object. Using for customization purpose.
    
    Parameters:
    
    String - xml
  - toXML
```
public java.lang.String toXML()
```
    Generate the nonBlaze promotion XML representation.
    
    Returns:
    
    java.lang.String
  - fromXML
```
public void fromXML(java.lang.String xml)
             throws ParameterNotFoundException,
                    java.text.ParseException
```
    Populate the promotion object from a nonBlaze XML representation.
    
    Parameters:
    
    String - xml
    
    Throws:
    
    ParameterNotFoundException
    
    java.text.ParseException
  - getAssignedSegments
```
public java.util.Vector getAssignedSegments()
```
    Get the assignedSegments.
    
    Returns:
    
    java.util.Vector
  - getCurrency
```
public java.lang.String getCurrency()
```
    Get the currency.
    
    Returns:
    
    java.lang.String
  - getDayInWeek
```
public java.util.Vector getDayInWeek()
```
    Get the daysInWeek.
    
    Returns:
    
    java.lang.String
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description.
    
    Returns:
    
    java.lang.String
  - getDescriptionLongNL
```
public java.lang.String getDescriptionLongNL()
```
    Get the customers viewable long description.
    
    Returns:
    
    java.lang.String
  - getDescriptionNL
```
public java.lang.String getDescriptionNL()
```
    Return the customers viewable description.
    
    Returns:
    
    java.lang.String
  - getEndTimeStamp
```
public java.sql.Timestamp getEndTimeStamp()
```
    Get the promotion end timestamp.
    
    Returns:
    
    java.sql.Timestamp
  - getName
```
public java.lang.String getName()
```
    Get the promotion name.
    
    Returns:
    
    java.lang.String
  - getPriority
```
public int getPriority()
```
    Get the promotion priority.
    
    Returns:
    
    int
  - getPromotionDisplayLevel
```
public abstract java.lang.Integer getPromotionDisplayLevel()
```
    Get the promotion display level.
    
    Returns:
    
    java.lang.Integer
  - getRLPromotionType
```
public java.lang.String getRLPromotionType()
```
    Get promotion type.
    
    Returns:
    
    java.lang.String
  - getStartTimeStamp
```
public java.sql.Timestamp getStartTimeStamp()
```
    Get promotion start timestamp.
    
    Returns:
    
    java.sql.Timestamp
  - getStatus
```
public int getStatus()
```
    Get promotion status.
    
    Returns:
    
    int
  - getTargetSalesFigure
```
public java.lang.String getTargetSalesFigure()
```
    Get promotion target sales.
    
    Returns:
    
    java.lang.String
  - getDateRanged
```
public boolean getDateRanged()
```
    Check if the promotion is scheduled by date.
    
    Returns:
    
    boolean
  - getTimeRanged
```
public boolean getTimeRanged()
```
    Check if the promotion is scheduled by time.
    
    Returns:
    
    boolean
  - getValidForAllCustomers
```
public boolean getValidForAllCustomers()
```
    Check if the promotion is valid for all customers.
    
    Returns:
    
    boolean
  - populateFrom
```
protected void populateFrom(java.util.Map h)
                     throws ParameterNotFoundException,
                            java.text.ParseException
```
    PopulateFrom is used to tell an RLPromotion to populate itself from a Map. This Map is generally the Map that the Tools Framework provides, and holds user entered data. This Map is passed from the controller command to the RLPromotionFactory, and the factory passes it to the class it instantiates. Note that the execution chain continues into populatePromotionSpecificDataFrom(Map) where implementation specific data is retrieved.
    
    Parameters:
    
    h - java.util.Hashtable
    
    Throws:
    
    ParameterNotFoundException
    
    java.text.ParseException
  - populatePromotionLevelSpecificDataFrom
```
public abstract void populatePromotionLevelSpecificDataFrom(java.util.Map h)
                                                     throws ParameterNotFoundException
```
    Populate promotion level specific data for itself from a Map. This Map is generally retrieved from Tools FrameWork GUI, and holds RLPromotion Object information. This map is passed from a controller command to the RLPromotionFactory, and the factory passes it to the class it instantiates. Each sub type of promotion will implement this method differently according to their own attributes.
    
    Parameters:
    
    h - java.util.Map
    
    Throws:
    
    ParameterNotFoundException
  - populatePromotionSpecificDataFrom
```
public abstract void populatePromotionSpecificDataFrom(java.util.Map h)
                                                throws ParameterNotFoundException
```
    Populate promotion specific data for itself from a Map. This Map is generally retrieved from Tools Frame Work GUI, and holds RLPromotion Object information. This map is passed from a controller command to the RLPromotionFactory, and the factory passes it to the class it instantiates. Each sub type of promotion will implement this method differently according to their own attributes.
    
    Parameters:
    
    h - java.util.Map
    
    Throws:
    
    ParameterNotFoundException
  - setDescription
```
public void setDescription(java.lang.String newDesc)
```
    Because the description is stored in the CalcoDesc table, it has to be set outside of 'populate' method.
    
    Parameters:
    
    desc - Description of this discount.
  - setDescriptionLongNL
```
public void setDescriptionLongNL(java.lang.String newDescriptionLongNL)
```
    Because the NL-enabled long description is stored in the CALCODEDSC table, it has to be set outside of 'populate' method.
    
    Parameters:
    
    newDescriptionLongNL - java.lang.String
  - setDescriptionNL
```
public void setDescriptionNL(java.lang.String newDescNL)
```
    Because the NL-enabled short description is stored in the CALCODEDSC table, it has to be set outside of 'populate' method.
    
    Parameters:
    
    desc - Description of this discount.
  - setName
```
public void setName(java.lang.String newDiscountName)
```
    Set the name of the Discount.
    
    Parameters:
    
    newDiscountName - java.lang.String
  - setTargetSalesFigure
```
public void setTargetSalesFigure(java.lang.String newTargetSalesFigure)
```
    targetSalesFigure is not stored in the XML string, it has to be set outside of 'populate' method.
    
    Parameters:
    
    targetSalesFigure - java.lang.String
  - setAssignedSegments
```
public void setAssignedSegments(java.util.Vector newAssignedSegments)
```
    Sets the assignedSegments.
    
    Parameters:
    
    assignedSegments - The assignedSegments to set
  - setCurrency
```
public void setCurrency(java.lang.String newCurrency)
```
    Sets the currency.
    
    Parameters:
    
    currency - The currency to set
  - getDaysInWeek
```
public java.util.Vector getDaysInWeek()
```
    Gets the daysInWeek.
    
    Returns:
    
    java.util.Vector
  - setDaysInWeek
```
public void setDaysInWeek(java.util.Vector newDaysInWeek)
```
    Sets the days in week.
    
    Parameters:
    
    Vector - newDaysInWeek
  - setEndTimeStamp
```
public void setEndTimeStamp(java.sql.Timestamp newEndTimeStamp)
```
    Sets the endTimeStamp.
    
    Parameters:
    
    endTimeStamp - The endTimeStamp to set
  - setPriority
```
public void setPriority(int newPriority)
```
    Sets the priority.
    
    Parameters:
    
    priority - The priority to set
  - setRLPromotionType
```
public void setRLPromotionType(java.lang.String newRlPromotionType)
```
    Sets the rlPromotionType.
    
    Parameters:
    
    rlPromotionType - The rlPromotionType to set
  - setStartTimeStamp
```
public void setStartTimeStamp(java.sql.Timestamp newStartTimeStamp)
```
    Sets the startTimeStamp.
    
    Parameters:
    
    startTimeStamp - The startTimeStamp to set
  - setStatus
```
public void setStatus(int newStatus)
```
    Sets the status.
    
    Parameters:
    
    newStatus - The status to set
  - getStoreId
```
public java.lang.String getStoreId()
```
    Gets the store ID of current RLPromotion object.
    
    Returns:
    
    String storeId
  - setStoreId
```
public void setStoreId(java.lang.String newStoreId)
```
    Sets the store ID of current RLPromotion object.
    
    Parameters:
    
    String - newStoreId
  - getLanguageId
```
public java.lang.String getLanguageId()
```
    Gets the language ID of current RLPromotion object description.
    
    Returns:
    
    String languageId
  - setLanguageId
```
public void setLanguageId(java.lang.String newLanguageId)
```
    Sets the language ID of current RLPromotion object description.
    
    Parameters:
    
    String - newLanguageId
  - getVersion
```
public int getVersion()
```
    Gets the version of current RLPromotion object.
    
    Returns:
    
    int version
  - setVersion
```
public void setVersion(int newVersion)
```
    Sets the version of current RLPromotion object. The default value is 0.
    
    Parameters:
    
    int - newVersion
  - getRevision
```
public int getRevision()
```
    Gets the revision of current RLPromotion object.
    
    Returns:
    
    int revision
  - setRevision
```
public void setRevision(int newRevision)
```
    Sets the revision of current RLPromotion object. The default value is 0.
    
    Parameters:
    
    int - newRevision
  - getGroupName
```
public java.lang.String getGroupName()
```
    Gets the group name of current RLPromotion object.
    
    Returns:
    
    String groupName
  - setGroupName
```
public void setGroupName(java.lang.String newGroupName)
```
    Sets the group name of current RLPromotion object.
    
    Parameters:
    
    String - newGroupName
  - getExclusive
```
public int getExclusive()
```
    Gets the exclusiveness of current RLPromotion object.
    
    Returns:
    
    int exclusive
  - setExclusive
```
public void setExclusive(int newExclusive)
```
    Sets the exclusiveness of current RLPromotion object.
```
 0 = not exclusive
 1 = exclusive at a group level
 2 = exclusive at a global level
 3 = combined with product promotion (order level and shipping only)
 
```
    Parameters:
    
    int - newExclusive
  - getPerOrderLimit
```
public int getPerOrderLimit()
```
    Gets the promotion applicable limit per order.
    
    Returns:
    
    int preOrderLimit
  - setPerOrderLimit
```
public void setPerOrderLimit(int newPerOrderLimit)
```
    Sets the promotion applicable limit per order.
    
    Parameters:
    
    int - newPerOrderLimit
  - getPerShopperLimit
```
public int getPerShopperLimit()
```
    Gets the promotion applicable limit per customer.
    
    Returns:
    
    int perShopperLimit
  - setPerShopperLimit
```
public void setPerShopperLimit(int newPerShopperLimit)
```
    Sets the promotion applicable limit per customer.
    
    Parameters:
    
    int - newPerShopperLimit
  - getTotalLimit
```
public int getTotalLimit()
```
    Gets the promotion total applicable limit.
    
    Returns:
    
    int totalLimit
  - setTotalLimit
```
public void setTotalLimit(int newTotalLimit)
```
    Sets the promotion total applicable limit.
    
    Parameters:
    
    int - newTotalLimit
  - getPromotionCode
```
public java.lang.String getPromotionCode()
```
    Gets the promotion code of current RLPromotion object.
    
    Returns:
    
    String promotionCode
  - setPromotionCode
```
public void setPromotionCode(java.lang.String newPromotionCode)
```
    Sets the promotion code of current RLPromotion object.
    
    Parameters:
    
    String - newPromotionCode
  - getCodeRequired
```
public boolean getCodeRequired()
```
    Check if the promotion code is required in this promotion.
    
    Returns:
    
    boolean codeRequired
  - setCodeRequired
```
public void setCodeRequired(boolean newCodeRequired)
```
    Sets the boolean value if the promotion code is required in this promotion.
    
    Parameters:
    
    boolean - newCodeRequired
  - getLastUpdateUserId
```
public java.lang.String getLastUpdateUserId()
```
    Gets the user logon ID who is the last one to update the current RLPromotion object.
    
    Returns:
    
    String lastUpdateUserId
  - setLastUpdateUserId
```
public void setLastUpdateUserId(java.lang.String newLastUpdateUserId)
```
    Sets the user logon ID who is the last one to update the current RLPromotion object.
    
    Parameters:
    
    String - newLastUpdateUserId
  - getLastUpdate
```
public java.sql.Timestamp getLastUpdate()
```
    Gets the timestamp when the current RLPromotion object was updated at last.
    
    Returns:
    
    Timestamp
  - setLastUpdate
```
public void setLastUpdate(java.sql.Timestamp newLastUpdate)
```
    Sets the Timestamp when the current RLPromotion object was updated at last.
    
    Parameters:
    
    Timestamp - newLastUpdate
  - getIsCoupon
```
public boolean getIsCoupon()
```
    Check if the current RLPromotion is a coupon promotion.
    
    Returns:
    
    boolean isCoupon
  - setIsCoupon
```
public void setIsCoupon(boolean newIsCoupon)
```
    Sets true if the current RLPromotion is a coupon promotion, otherwise false.
    
    Parameters:
    
    boolean - newIsCoupon
  - getCouponEffectiveDays
```
public int getCouponEffectiveDays()
```
    Gets the coupon effective days.
    
    Returns:
    
    int couponeEffectiveDays
  - setCouponEffectiveDays
```
public void setCouponEffectiveDays(int newCouponEffectiveDays)
```
    Sets the coupon effective days.
    
    Parameters:
    
    int - newCouponEffectiveDays
  - getCouponExpirationDays
```
public int getCouponExpirationDays()
```
    Gets the coupon expiration days.
    
    Returns:
    
    int couponExpirationDays
  - setCouponExpirationDays
```
public void setCouponExpirationDays(int newCouponExpirationDays)
```
    Sets the coupon expiration days.
    
    Parameters:
    
    int - newCouponExpirationDays
  - getAllowCouponTransfer
```
public boolean getAllowCouponTransfer()
```
    Gets true only if this is a coupon promotion and allow this coupon promotion to be transferred.
    
    Returns:
    
    boolean allowCouponTransfer
  - setAllowCouponTransfer
```
public void setAllowCouponTransfer(boolean newAllowCouponTransfer)
```
    Sets true only if this is a coupon promotion and allow this coupon promotion to be transferred.
    
    Parameters:
    
    boolean - newAllowCouponTransfer
  - getIsAdjustmentBasedOnStandardOfferPrice
```
public boolean getIsAdjustmentBasedOnStandardOfferPrice()
```
    Gets true only if adjustment is based on standard offer price.
    
    Returns:
    
    boolean isAdjustmentBasedOnStandardOfferPrice
  - getAssignedSegmentIds
```
public java.util.Vector getAssignedSegmentIds()
```
    Get the assignedSegmentIds
    
    Returns:
    
    java.util.Vector
  - setAssignedSegmentIds
```
public void setAssignedSegmentIds(java.util.Vector newAssignedSegmentIds)
```
    Sets the assignedSegmentIds
    
    Parameters:
    
    assignedSegmentIds - The assignedSegmentIds to set

Class RLPromotion

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

RLPromotion

Method Detail

toSpecificXML

fromSpecificXML

toCustomXML

fromCustomXML

toXML

fromXML

getAssignedSegments

getCurrency

getDayInWeek

getDescription

getDescriptionLongNL

getDescriptionNL

getEndTimeStamp

getName

getPriority

getPromotionDisplayLevel

getRLPromotionType

getStartTimeStamp

getStatus

getTargetSalesFigure

getDateRanged

getTimeRanged

getValidForAllCustomers

populateFrom

populatePromotionLevelSpecificDataFrom

populatePromotionSpecificDataFrom

setDescription

setDescriptionLongNL

setDescriptionNL

setName

setTargetSalesFigure

setAssignedSegments

setCurrency

getDaysInWeek

setDaysInWeek

setEndTimeStamp

setPriority

setRLPromotionType

setStartTimeStamp

setStatus

getStoreId

setStoreId

getLanguageId

setLanguageId

getVersion

setVersion

getRevision

setRevision

getGroupName

setGroupName

getExclusive

setExclusive

getPerOrderLimit

setPerOrderLimit

getPerShopperLimit

setPerShopperLimit

getTotalLimit

setTotalLimit

getPromotionCode

setPromotionCode

getCodeRequired

setCodeRequired

getLastUpdateUserId

setLastUpdateUserId

getLastUpdate

setLastUpdate

getIsCoupon

setIsCoupon

getCouponEffectiveDays