Promotion (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.Promotion

All Implemented Interfaces:

PromotionIf
```
public class Promotion
extends java.lang.Object
implements PromotionIf
```
This is the Promotion class - it contains information about the promotion; links it to the Order Total module that is used to calculate the promotion, and identifies to what products and customers the promotion applies.

Constructor Summary

Constructors
Constructor and Description
`Promotion()` Constructor
`Promotion(com.workingdogs.village.Record vr, KKCriteria c)` Instantiates the attributes of the Promotion object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OrderProductIf[]`	`getApplicableProducts()` Contains an array of OrderProduct objects to which the promotion can be applied.
`int`	`getCategoryRule()` This is the rule linking categories to the promotion.
`CouponIf`	`getCoupon()` There may be a coupon associated with the promotion.
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom10()`
`java.lang.String`	`getCustom11()`
`java.lang.String`	`getCustom12()`
`java.lang.String`	`getCustom13()`
`java.lang.String`	`getCustom14()`
`java.lang.String`	`getCustom15()`
`java.lang.String`	`getCustom16()`
`java.lang.String`	`getCustom17()`
`java.lang.String`	`getCustom18()`
`java.lang.String`	`getCustom19()`
`java.lang.String`	`getCustom2()`
`java.lang.String`	`getCustom20()`
`java.lang.String`	`getCustom3()`
`java.lang.String`	`getCustom4()`
`java.lang.String`	`getCustom5()`
`java.lang.String`	`getCustom6()`
`java.lang.String`	`getCustom7()`
`java.lang.String`	`getCustom8()`
`java.lang.String`	`getCustom9()`
`int`	`getCustomerGroupRule()` This is the rule linking customer groups to the promotion.
`int`	`getCustomerRule()` This is the rule linking customers to the promotion.
`java.util.Calendar`	`getDateAdded()`
`java.lang.String`	`getDescription()` A description of the promotion.
`java.util.Calendar`	`getEndDate()` After this date the promotion is no longer active.
`CategoryIf[]`	`getExcludedCategories()` An array of categories that the promotion excludes.
`ManufacturerIf[]`	`getExcludedManufacturers()` An array of manufacturers that the promotion excludes.
`ProductIf[]`	`getExcludedProducts()` An array of products that the promotion excludes.
`int`	`getId()`
`CategoryIf[]`	`getIncludedCategories()` An array of categories that the promotion includes.
`ManufacturerIf[]`	`getIncludedManufacturers()` An array of manufacturers that the promotion includes.
`ProductIf[]`	`getIncludedProducts()` An array of products that the promotion includes.
`java.util.Calendar`	`getLastModified()`
`int`	`getManufacturerRule()` This is the rule linking manufacturers to the promotion.
`int`	`getMaxUse()` The maximum number of times that the promotion can be used by a single customer
`java.lang.String`	`getName()` The promotion name.
`java.lang.String`	`getOrderTotalCode()` The code of the order total module used to calculate the promotion.
`int`	`getProductRule()` This is the rule linking products to the promotion.
`java.util.Calendar`	`getStartDate()` Before this date the promotion is not active.
`boolean`	`getStatus(java.util.Date storeTime)` Returns the status of the object.
`int`	`getTimesUsed()` The number of times that the promotion has been used
`int`	`getTotalMaxUse()` The maximum number of times that the promotion can be used
`boolean`	`isActive()` Set to true if the promotion is active.
`boolean`	`isCumulative()` Set to true if the promotion is cumulative with other promotions.
`boolean`	`isRequiresCoupon()` Does the promotion require a coupon
`void`	`setActive(boolean active)` Set to true if the promotion is active.
`void`	`setApplicableProducts(OrderProductIf[] applicableProducts)` Contains an array of OrderProduct objects to which the promotion can be applied.
`void`	`setCategoryRule(int categoryRule)` This is the rule linking categories to the promotion.
`void`	`setCoupon(CouponIf coupon)` There may be a coupon associated with the promotion.
`void`	`setCumulative(boolean cumulative)` Set to true if the promotion is cumulative with other promotions.
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom10(java.lang.String custom10)`
`void`	`setCustom11(java.lang.String custom11)`
`void`	`setCustom12(java.lang.String custom12)`
`void`	`setCustom13(java.lang.String custom13)`
`void`	`setCustom14(java.lang.String custom14)`
`void`	`setCustom15(java.lang.String custom15)`
`void`	`setCustom16(java.lang.String custom16)`
`void`	`setCustom17(java.lang.String custom17)`
`void`	`setCustom18(java.lang.String custom18)`
`void`	`setCustom19(java.lang.String custom19)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom20(java.lang.String custom20)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom5(java.lang.String custom5)`
`void`	`setCustom6(java.lang.String custom6)`
`void`	`setCustom7(java.lang.String custom7)`
`void`	`setCustom8(java.lang.String custom8)`
`void`	`setCustom9(java.lang.String custom9)`
`void`	`setCustomerGroupRule(int customerGroupRule)` This is the rule linking customer groups to the promotion.
`void`	`setCustomerRule(int customerRule)` This is the rule linking customers to the promotion.
`void`	`setDateAdded(java.util.Calendar dateAdded)`
`void`	`setDescription(java.lang.String description)` A description of the promotion.
`void`	`setEndDate(java.util.Calendar endDate)` After this date the promotion is no longer active.
`void`	`setExcludedCategories(CategoryIf[] excludedCategories)` An array of categories that the promotion excludes.
`void`	`setExcludedManufacturers(ManufacturerIf[] excludedManufacturers)` An array of manufacturers that the promotion excludes.
`void`	`setExcludedProducts(ProductIf[] excludedProducts)` An array of products that the promotion excludes.
`void`	`setId(int id)`
`void`	`setIncludedCategories(CategoryIf[] includedCategories)` An array of categories that the promotion includes.
`void`	`setIncludedManufacturers(ManufacturerIf[] includedManufacturers)` An array of manufacturers that the promotion includes.
`void`	`setIncludedProducts(ProductIf[] includedProducts)` An array of products that the promotion includes.
`void`	`setLastModified(java.util.Calendar lastModified)`
`void`	`setManufacturerRule(int manufacturerRule)` This is the rule linking manufacturers to the promotion.
`void`	`setMaxUse(int maxUse)` The maximum number of times that the promotion can be used by a single customer
`void`	`setName(java.lang.String name)` The promotion name.
`void`	`setOrderTotalCode(java.lang.String orderTotalCode)` The code of the order total module used to calculate the promotion.
`void`	`setProductRule(int productRule)` This is the rule linking products to the promotion.
`void`	`setRequiresCoupon(boolean requiresCoupon)` Does the promotion require a coupon
`void`	`setStartDate(java.util.Calendar startDate)` Before this date the promotion is not active.
`void`	`setTimesUsed(int timesUsed)` The number of times that the promotion has been used
`void`	`setTotalMaxUse(int totalMaxUse)` The maximum number of times that the promotion can be used
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

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

- Constructor Detail
  - Promotion
```
public Promotion()
```
    Constructor
  - Promotion
```
public Promotion(com.workingdogs.village.Record vr,
                 KKCriteria c)
          throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the Promotion object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Promotion object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the Promotion object.
  - isActive
```
public boolean isActive()
```
    Description copied from interface: PromotionIf
    
    Set to true if the promotion is active.
    
    Specified by:
    
    isActive in interface PromotionIf
    
    Returns:
    
    Returns the value of the status attribute of the object.
  - getStatus
```
public boolean getStatus(java.util.Date storeTime)
```
    Returns the status of the object. In order to calculate whether the promotion is active, the following are used:
    - The start and end dates which are compared to the current store time
    - The number of times the promotion has been used
    - The active attribute of the promotion (e.g. isActive()). If this is false then by default the promotion is not active.
    Parameters:
    
    storeTime - The current storeTime which is used to compare with the start and end dates of the promotion. If null then the standard time of the server is used.
    
    Returns:
    
    Returns the status of the object.
  - setActive
```
public void setActive(boolean active)
```
    Description copied from interface: PromotionIf
    
    Set to true if the promotion is active.
    
    Specified by:
    
    setActive in interface PromotionIf
    
    Parameters:
    
    active - The active to set.
  - isCumulative
```
public boolean isCumulative()
```
    Description copied from interface: PromotionIf
    
    Set to true if the promotion is cumulative with other promotions. If it isn't cumulative but more than one promotion could apply to the order, then the promotion giving the maximum discount is used.
    
    Specified by:
    
    isCumulative in interface PromotionIf
    
    Returns:
    
    Returns the cumulative.
  - setCumulative
```
public void setCumulative(boolean cumulative)
```
    Description copied from interface: PromotionIf
    
    Set to true if the promotion is cumulative with other promotions. If it isn't cumulative but more than one promotion could apply to the order, then the promotion giving the maximum discount is used.
    
    Specified by:
    
    setCumulative in interface PromotionIf
    
    Parameters:
    
    cumulative - The cumulative to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface PromotionIf
    
    Returns:
    
    Returns the custom1.
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface PromotionIf
    
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface PromotionIf
    
    Returns:
    
    Returns the custom2.
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface PromotionIf
    
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
public java.lang.String getCustom3()
```
    Specified by:
    
    getCustom3 in interface PromotionIf
    
    Returns:
    
    Returns the custom3.
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Specified by:
    
    setCustom3 in interface PromotionIf
    
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
public java.lang.String getCustom4()
```
    Specified by:
    
    getCustom4 in interface PromotionIf
    
    Returns:
    
    Returns the custom4.
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Specified by:
    
    setCustom4 in interface PromotionIf
    
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
public java.lang.String getCustom5()
```
    Specified by:
    
    getCustom5 in interface PromotionIf
    
    Returns:
    
    Returns the custom5.
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Specified by:
    
    setCustom5 in interface PromotionIf
    
    Parameters:
    
    custom5 - The custom5 to set.
  - getCustom6
```
public java.lang.String getCustom6()
```
    Specified by:
    
    getCustom6 in interface PromotionIf
    
    Returns:
    
    Returns the custom6.
  - setCustom6
```
public void setCustom6(java.lang.String custom6)
```
    Specified by:
    
    setCustom6 in interface PromotionIf
    
    Parameters:
    
    custom6 - The custom6 to set.
  - getCustom7
```
public java.lang.String getCustom7()
```
    Specified by:
    
    getCustom7 in interface PromotionIf
    
    Returns:
    
    Returns the custom7.
  - setCustom7
```
public void setCustom7(java.lang.String custom7)
```
    Specified by:
    
    setCustom7 in interface PromotionIf
    
    Parameters:
    
    custom7 - The custom7 to set.
  - getCustom8
```
public java.lang.String getCustom8()
```
    Specified by:
    
    getCustom8 in interface PromotionIf
    
    Returns:
    
    Returns the custom8.
  - setCustom8
```
public void setCustom8(java.lang.String custom8)
```
    Specified by:
    
    setCustom8 in interface PromotionIf
    
    Parameters:
    
    custom8 - The custom8 to set.
  - getCustom9
```
public java.lang.String getCustom9()
```
    Specified by:
    
    getCustom9 in interface PromotionIf
    
    Returns:
    
    Returns the custom9.
  - setCustom9
```
public void setCustom9(java.lang.String custom9)
```
    Specified by:
    
    setCustom9 in interface PromotionIf
    
    Parameters:
    
    custom9 - The custom9 to set.
  - getCustom10
```
public java.lang.String getCustom10()
```
    Specified by:
    
    getCustom10 in interface PromotionIf
    
    Returns:
    
    Returns the custom10.
  - setCustom10
```
public void setCustom10(java.lang.String custom10)
```
    Specified by:
    
    setCustom10 in interface PromotionIf
    
    Parameters:
    
    custom10 - The custom10 to set.
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface PromotionIf
    
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Specified by:
    
    setId in interface PromotionIf
    
    Parameters:
    
    id - The id to set.
  - getOrderTotalCode
```
public java.lang.String getOrderTotalCode()
```
    Description copied from interface: PromotionIf
    
    The code of the order total module used to calculate the promotion.
    
    Specified by:
    
    getOrderTotalCode in interface PromotionIf
    
    Returns:
    
    Returns the orderTotalCode.
  - setOrderTotalCode
```
public void setOrderTotalCode(java.lang.String orderTotalCode)
```
    Description copied from interface: PromotionIf
    
    The code of the order total module used to calculate the promotion.
    
    Specified by:
    
    setOrderTotalCode in interface PromotionIf
    
    Parameters:
    
    orderTotalCode - The orderTotalCode to set.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: PromotionIf
    
    The promotion name.
    
    Specified by:
    
    getName in interface PromotionIf
    
    Returns:
    
    Returns the name.
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: PromotionIf
    
    The promotion name.
    
    Specified by:
    
    setName in interface PromotionIf
    
    Parameters:
    
    name - The name to set.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: PromotionIf
    
    A description of the promotion.
    
    Specified by:
    
    getDescription in interface PromotionIf
    
    Returns:
    
    Returns the description.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description copied from interface: PromotionIf
    
    A description of the promotion.
    
    Specified by:
    
    setDescription in interface PromotionIf
    
    Parameters:
    
    description - The description to set.
  - isRequiresCoupon
```
public boolean isRequiresCoupon()
```
    Description copied from interface: PromotionIf
    
    Does the promotion require a coupon
    
    Specified by:
    
    isRequiresCoupon in interface PromotionIf
    
    Returns:
    
    Returns the requiresCoupon.
  - setRequiresCoupon
```
public void setRequiresCoupon(boolean requiresCoupon)
```
    Description copied from interface: PromotionIf
    
    Does the promotion require a coupon
    
    Specified by:
    
    setRequiresCoupon in interface PromotionIf
    
    Parameters:
    
    requiresCoupon - The requiresCoupon to set.
  - getCategoryRule
```
public int getCategoryRule()
```
    Description copied from interface: PromotionIf
    This is the rule linking categories to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all categories
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some categories
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some categories
    Specified by:
    
    getCategoryRule in interface PromotionIf
    
    Returns:
    
    Returns the categoryRule.
  - setCategoryRule
```
public void setCategoryRule(int categoryRule)
```
    Description copied from interface: PromotionIf
    This is the rule linking categories to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all categories
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some categories
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some categories
    Specified by:
    
    setCategoryRule in interface PromotionIf
    
    Parameters:
    
    categoryRule - The categoryRule to set.
  - getCustomerRule
```
public int getCustomerRule()
```
    Description copied from interface: PromotionIf
    This is the rule linking customers to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all customers
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some customers
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some customers
    Specified by:
    
    getCustomerRule in interface PromotionIf
    
    Returns:
    
    Returns the customerRule.
  - setCustomerRule
```
public void setCustomerRule(int customerRule)
```
    Description copied from interface: PromotionIf
    This is the rule linking customers to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all customers
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some customers
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some customers
    Specified by:
    
    setCustomerRule in interface PromotionIf
    
    Parameters:
    
    customerRule - The customerRule to set.
  - getManufacturerRule
```
public int getManufacturerRule()
```
    Description copied from interface: PromotionIf
    This is the rule linking manufacturers to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all manufacturers
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some manufacturers
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some manufacturers
    Specified by:
    
    getManufacturerRule in interface PromotionIf
    
    Returns:
    
    Returns the manufacturerRule.
  - setManufacturerRule
```
public void setManufacturerRule(int manufacturerRule)
```
    Description copied from interface: PromotionIf
    This is the rule linking manufacturers to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all manufacturers
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some manufacturers
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some manufacturers
    Specified by:
    
    setManufacturerRule in interface PromotionIf
    
    Parameters:
    
    manufacturerRule - The manufacturerRule to set.
  - getProductRule
```
public int getProductRule()
```
    Description copied from interface: PromotionIf
    This is the rule linking products to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all products
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some products
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some products
    Specified by:
    
    getProductRule in interface PromotionIf
    
    Returns:
    
    Returns the productRule.
  - setProductRule
```
public void setProductRule(int productRule)
```
    Description copied from interface: PromotionIf
    This is the rule linking products to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all products
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some products
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some products
    Specified by:
    
    setProductRule in interface PromotionIf
    
    Parameters:
    
    productRule - The productRule to set.
  - getApplicableProducts
```
public OrderProductIf[] getApplicableProducts()
```
    Description copied from interface: PromotionIf
    
    Contains an array of OrderProduct objects to which the promotion can be applied.
    
    Specified by:
    
    getApplicableProducts in interface PromotionIf
    
    Returns:
    
    Returns the applicableProducts.
  - setApplicableProducts
```
public void setApplicableProducts(OrderProductIf[] applicableProducts)
```
    Description copied from interface: PromotionIf
    
    Contains an array of OrderProduct objects to which the promotion can be applied.
    
    Specified by:
    
    setApplicableProducts in interface PromotionIf
    
    Parameters:
    
    applicableProducts - The applicableProducts to set.
  - getDateAdded
```
public java.util.Calendar getDateAdded()
```
    Specified by:
    
    getDateAdded in interface PromotionIf
    
    Returns:
    
    Returns the dateAdded.
  - setDateAdded
```
public void setDateAdded(java.util.Calendar dateAdded)
```
    Specified by:
    
    setDateAdded in interface PromotionIf
    
    Parameters:
    
    dateAdded - The dateAdded to set.
  - getEndDate
```
public java.util.Calendar getEndDate()
```
    Description copied from interface: PromotionIf
    
    After this date the promotion is no longer active.
    
    Specified by:
    
    getEndDate in interface PromotionIf
    
    Returns:
    
    Returns the endDate.
  - setEndDate
```
public void setEndDate(java.util.Calendar endDate)
```
    Description copied from interface: PromotionIf
    
    After this date the promotion is no longer active.
    
    Specified by:
    
    setEndDate in interface PromotionIf
    
    Parameters:
    
    endDate - The endDate to set.
  - getLastModified
```
public java.util.Calendar getLastModified()
```
    Specified by:
    
    getLastModified in interface PromotionIf
    
    Returns:
    
    Returns the lastModified.
  - setLastModified
```
public void setLastModified(java.util.Calendar lastModified)
```
    Specified by:
    
    setLastModified in interface PromotionIf
    
    Parameters:
    
    lastModified - The lastModified to set.
  - getStartDate
```
public java.util.Calendar getStartDate()
```
    Description copied from interface: PromotionIf
    
    Before this date the promotion is not active.
    
    Specified by:
    
    getStartDate in interface PromotionIf
    
    Returns:
    
    Returns the startDate.
  - setStartDate
```
public void setStartDate(java.util.Calendar startDate)
```
    Description copied from interface: PromotionIf
    
    Before this date the promotion is not active.
    
    Specified by:
    
    setStartDate in interface PromotionIf
    
    Parameters:
    
    startDate - The startDate to set.
  - getCoupon
```
public CouponIf getCoupon()
```
    Description copied from interface: PromotionIf
    
    There may be a coupon associated with the promotion.
    
    Specified by:
    
    getCoupon in interface PromotionIf
    
    Returns:
    
    Returns the coupon.
  - setCoupon
```
public void setCoupon(CouponIf coupon)
```
    Description copied from interface: PromotionIf
    
    There may be a coupon associated with the promotion.
    
    Specified by:
    
    setCoupon in interface PromotionIf
    
    Parameters:
    
    coupon - The coupon to set.
  - getCustomerGroupRule
```
public int getCustomerGroupRule()
```
    Description copied from interface: PromotionIf
    This is the rule linking customer groups to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all customer groups
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some customer groups
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some customer groups
    Specified by:
    
    getCustomerGroupRule in interface PromotionIf
    
    Returns:
    
    Returns the customerGroupRule.
  - setCustomerGroupRule
```
public void setCustomerGroupRule(int customerGroupRule)
```
    Description copied from interface: PromotionIf
    This is the rule linking customer groups to the promotion. Valid values are:
    - com.konakart.bl.PromotionMgr.ALL - Include all customer groups
    - com.konakart.bl.PromotionMgr.EXCLUDE - Exclude some customer groups
    - com.konakart.bl.PromotionMgr.INCLUDE - Include some customer groups
    Specified by:
    
    setCustomerGroupRule in interface PromotionIf
    
    Parameters:
    
    customerGroupRule - The customerGroupRule to set.
  - getMaxUse
```
public int getMaxUse()
```
    Description copied from interface: PromotionIf
    
    The maximum number of times that the promotion can be used by a single customer
    
    Specified by:
    
    getMaxUse in interface PromotionIf
    
    Returns:
    
    the maxUse
  - setMaxUse
```
public void setMaxUse(int maxUse)
```
    Description copied from interface: PromotionIf
    
    The maximum number of times that the promotion can be used by a single customer
    
    Specified by:
    
    setMaxUse in interface PromotionIf
    
    Parameters:
    
    maxUse - the maxUse to set
  - getTotalMaxUse
```
public int getTotalMaxUse()
```
    Description copied from interface: PromotionIf
    
    The maximum number of times that the promotion can be used
    
    Specified by:
    
    getTotalMaxUse in interface PromotionIf
    
    Returns:
    
    the totalMaxUse
  - setTotalMaxUse
```
public void setTotalMaxUse(int totalMaxUse)
```
    Description copied from interface: PromotionIf
    
    The maximum number of times that the promotion can be used
    
    Specified by:
    
    setTotalMaxUse in interface PromotionIf
    
    Parameters:
    
    totalMaxUse - the totalMaxUse to set
  - getTimesUsed
```
public int getTimesUsed()
```
    Description copied from interface: PromotionIf
    
    The number of times that the promotion has been used
    
    Specified by:
    
    getTimesUsed in interface PromotionIf
    
    Returns:
    
    the timesUsed
  - setTimesUsed
```
public void setTimesUsed(int timesUsed)
```
    Description copied from interface: PromotionIf
    
    The number of times that the promotion has been used
    
    Specified by:
    
    setTimesUsed in interface PromotionIf
    
    Parameters:
    
    timesUsed - the timesUsed to set
  - getIncludedProducts
```
public ProductIf[] getIncludedProducts()
```
    Description copied from interface: PromotionIf
    
    An array of products that the promotion includes. If the array is not empty, then the promotion only applies to products in the array. The array may contain multiple variants of the same product.
    
    Specified by:
    
    getIncludedProducts in interface PromotionIf
    
    Returns:
    
    the includedProducts
  - setIncludedProducts
```
public void setIncludedProducts(ProductIf[] includedProducts)
```
    Description copied from interface: PromotionIf
    
    An array of products that the promotion includes. If the array is not empty, then the promotion only applies to products in the array. The array may contain multiple variants of the same product.
    
    Specified by:
    
    setIncludedProducts in interface PromotionIf
    
    Parameters:
    
    includedProducts - the includedProducts to set
  - getExcludedProducts
```
public ProductIf[] getExcludedProducts()
```
    Description copied from interface: PromotionIf
    
    An array of products that the promotion excludes. If the array is not empty, then the promotion applies to all products except for the ones in the array. The array may contain multiple variants of the same product.
    
    Specified by:
    
    getExcludedProducts in interface PromotionIf
    
    Returns:
    
    the excludedProducts
  - setExcludedProducts
```
public void setExcludedProducts(ProductIf[] excludedProducts)
```
    Description copied from interface: PromotionIf
    
    An array of products that the promotion excludes. If the array is not empty, then the promotion applies to all products except for the ones in the array. The array may contain multiple variants of the same product.
    
    Specified by:
    
    setExcludedProducts in interface PromotionIf
    
    Parameters:
    
    excludedProducts - the excludedProducts to set
  - getIncludedCategories
```
public CategoryIf[] getIncludedCategories()
```
    Description copied from interface: PromotionIf
    
    An array of categories that the promotion includes. If the array is not empty, then the promotion only applies to categories in the array.
    
    Specified by:
    
    getIncludedCategories in interface PromotionIf
    
    Returns:
    
    the includedCategories
  - setIncludedCategories
```
public void setIncludedCategories(CategoryIf[] includedCategories)
```
    Description copied from interface: PromotionIf
    
    An array of categories that the promotion includes. If the array is not empty, then the promotion only applies to categories in the array.
    
    Specified by:
    
    setIncludedCategories in interface PromotionIf
    
    Parameters:
    
    includedCategories - the includedCategories to set
  - getExcludedCategories
```
public CategoryIf[] getExcludedCategories()
```
    Description copied from interface: PromotionIf
    
    An array of categories that the promotion excludes. If the array is not empty, then the promotion applies to all categories except for the ones in the array.
    
    Specified by:
    
    getExcludedCategories in interface PromotionIf
    
    Returns:
    
    the excludedCategories
  - setExcludedCategories
```
public void setExcludedCategories(CategoryIf[] excludedCategories)
```
    Description copied from interface: PromotionIf
    
    An array of categories that the promotion excludes. If the array is not empty, then the promotion applies to all categories except for the ones in the array.
    
    Specified by:
    
    setExcludedCategories in interface PromotionIf
    
    Parameters:
    
    excludedCategories - the excludedCategories to set
  - getIncludedManufacturers
```
public ManufacturerIf[] getIncludedManufacturers()
```
    Description copied from interface: PromotionIf
    
    An array of manufacturers that the promotion includes. If the array is not empty, then the promotion only applies to manufacturers in the array.
    
    Specified by:
    
    getIncludedManufacturers in interface PromotionIf
    
    Returns:
    
    the includedManufacturers
  - setIncludedManufacturers
```
public void setIncludedManufacturers(ManufacturerIf[] includedManufacturers)
```
    Description copied from interface: PromotionIf
    
    An array of manufacturers that the promotion includes. If the array is not empty, then the promotion only applies to manufacturers in the array.
    
    Specified by:
    
    setIncludedManufacturers in interface PromotionIf
    
    Parameters:
    
    includedManufacturers - the includedManufacturers to set
  - getExcludedManufacturers
```
public ManufacturerIf[] getExcludedManufacturers()
```
    Description copied from interface: PromotionIf
    
    An array of manufacturers that the promotion excludes. If the array is not empty, then the promotion applies to all manufacturers except for the ones in the array.
    
    Specified by:
    
    getExcludedManufacturers in interface PromotionIf
    
    Returns:
    
    the excludedManufacturers
  - setExcludedManufacturers
```
public void setExcludedManufacturers(ManufacturerIf[] excludedManufacturers)
```
    Description copied from interface: PromotionIf
    
    An array of manufacturers that the promotion excludes. If the array is not empty, then the promotion applies to all manufacturers except for the ones in the array.
    
    Specified by:
    
    setExcludedManufacturers in interface PromotionIf
    
    Parameters:
    
    excludedManufacturers - the excludedManufacturers to set
  - getCustom11
```
public java.lang.String getCustom11()
```
    Specified by:
    
    getCustom11 in interface PromotionIf
    
    Returns:
    
    the custom11
  - setCustom11
```
public void setCustom11(java.lang.String custom11)
```
    Specified by:
    
    setCustom11 in interface PromotionIf
    
    Parameters:
    
    custom11 - the custom11 to set
  - getCustom12
```
public java.lang.String getCustom12()
```
    Specified by:
    
    getCustom12 in interface PromotionIf
    
    Returns:
    
    the custom12
  - setCustom12
```
public void setCustom12(java.lang.String custom12)
```
    Specified by:
    
    setCustom12 in interface PromotionIf
    
    Parameters:
    
    custom12 - the custom12 to set
  - getCustom13
```
public java.lang.String getCustom13()
```
    Specified by:
    
    getCustom13 in interface PromotionIf
    
    Returns:
    
    the custom13
  - setCustom13
```
public void setCustom13(java.lang.String custom13)
```
    Specified by:
    
    setCustom13 in interface PromotionIf
    
    Parameters:
    
    custom13 - the custom13 to set
  - getCustom14
```
public java.lang.String getCustom14()
```
    Specified by:
    
    getCustom14 in interface PromotionIf
    
    Returns:
    
    the custom14
  - setCustom14
```
public void setCustom14(java.lang.String custom14)
```
    Specified by:
    
    setCustom14 in interface PromotionIf
    
    Parameters:
    
    custom14 - the custom14 to set
  - getCustom15
```
public java.lang.String getCustom15()
```
    Specified by:
    
    getCustom15 in interface PromotionIf
    
    Returns:
    
    the custom15
  - setCustom15
```
public void setCustom15(java.lang.String custom15)
```
    Specified by:
    
    setCustom15 in interface PromotionIf
    
    Parameters:
    
    custom15 - the custom15 to set
  - getCustom16
```
public java.lang.String getCustom16()
```
    Specified by:
    
    getCustom16 in interface PromotionIf
    
    Returns:
    
    the custom16
  - setCustom16
```
public void setCustom16(java.lang.String custom16)
```
    Specified by:
    
    setCustom16 in interface PromotionIf
    
    Parameters:
    
    custom16 - the custom16 to set
  - getCustom17
```
public java.lang.String getCustom17()
```
    Specified by:
    
    getCustom17 in interface PromotionIf
    
    Returns:
    
    the custom17
  - setCustom17
```
public void setCustom17(java.lang.String custom17)
```
    Specified by:
    
    setCustom17 in interface PromotionIf
    
    Parameters:
    
    custom17 - the custom17 to set
  - getCustom18
```
public java.lang.String getCustom18()
```
    Specified by:
    
    getCustom18 in interface PromotionIf
    
    Returns:
    
    the custom18
  - setCustom18
```
public void setCustom18(java.lang.String custom18)
```
    Specified by:
    
    setCustom18 in interface PromotionIf
    
    Parameters:
    
    custom18 - the custom18 to set
  - getCustom19
```
public java.lang.String getCustom19()
```
    Specified by:
    
    getCustom19 in interface PromotionIf
    
    Returns:
    
    the custom19
  - setCustom19
```
public void setCustom19(java.lang.String custom19)
```
    Specified by:
    
    setCustom19 in interface PromotionIf
    
    Parameters:
    
    custom19 - the custom19 to set
  - getCustom20
```
public java.lang.String getCustom20()
```
    Specified by:
    
    getCustom20 in interface PromotionIf
    
    Returns:
    
    the custom20
  - setCustom20
```
public void setCustom20(java.lang.String custom20)
```
    Specified by:
    
    setCustom20 in interface PromotionIf
    
    Parameters:
    
    custom20 - the custom20 to set

Class Promotion

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Promotion

Promotion

Method Detail

toString

toStringBrief

isActive

getStatus

setActive

isCumulative

setCumulative

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCustom6

setCustom6

getCustom7

setCustom7

getCustom8

setCustom8

getCustom9

setCustom9

getCustom10

setCustom10

getId

setId

getOrderTotalCode

setOrderTotalCode

getName

setName

getDescription

setDescription

isRequiresCoupon

setRequiresCoupon

getCategoryRule

setCategoryRule

getCustomerRule

setCustomerRule

getManufacturerRule

setManufacturerRule

getProductRule

setProductRule

getApplicableProducts

setApplicableProducts

getDateAdded

setDateAdded

getEndDate

setEndDate

getLastModified

setLastModified

getStartDate

setStartDate

getCoupon

setCoupon

getCustomerGroupRule

setCustomerGroupRule

getMaxUse

setMaxUse

getTotalMaxUse

setTotalMaxUse

getTimesUsed

setTimesUsed

getIncludedProducts

setIncludedProducts

getExcludedProducts

setExcludedProducts

getIncludedCategories

setIncludedCategories

getExcludedCategories