com.konakart.appif
Interface PromotionIf

All Known Implementing Classes:

Promotion

public interface PromotionIf

The Promotion object contains information about the promotion.

Method Summary

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	getCustom2()
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.
int	getId()
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	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	setCustom2(java.lang.String custom2)
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	setId(int id)
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.

Method Detail

isActive

boolean isActive()

Set to true if the promotion is active.

Returns:

Returns the active.

setActive

void setActive(boolean active)

Set to true if the promotion is active.

Parameters:

active - The active to set.

isCumulative

boolean isCumulative()

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.

Returns:

Returns the cumulative.

setCumulative

void setCumulative(boolean cumulative)

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.

Parameters:

cumulative - The cumulative to set.

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.

getCustom6

java.lang.String getCustom6()

Returns:

Returns the custom6.

setCustom6

void setCustom6(java.lang.String custom6)

Parameters:

custom6 - The custom6 to set.

getCustom7

java.lang.String getCustom7()

Returns:

Returns the custom7.

setCustom7

void setCustom7(java.lang.String custom7)

Parameters:

custom7 - The custom7 to set.

getCustom8

java.lang.String getCustom8()

Returns:

Returns the custom8.

setCustom8

void setCustom8(java.lang.String custom8)

Parameters:

custom8 - The custom8 to set.

getCustom9

java.lang.String getCustom9()

Returns:

Returns the custom9.

setCustom9

void setCustom9(java.lang.String custom9)

Parameters:

custom9 - The custom9 to set.

getCustom10

java.lang.String getCustom10()

Returns:

Returns the custom10.

setCustom10

void setCustom10(java.lang.String custom10)

Parameters:

custom10 - The custom10 to set.

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getOrderTotalCode

java.lang.String getOrderTotalCode()

The code of the order total module used to calculate the promotion.

Returns:

Returns the orderTotalCode.

setOrderTotalCode

void setOrderTotalCode(java.lang.String orderTotalCode)

The code of the order total module used to calculate the promotion.

Parameters:

orderTotalCode - The orderTotalCode to set.

getName

java.lang.String getName()

The promotion name.

Returns:

Returns the name.

setName

void setName(java.lang.String name)

The promotion name.

Parameters:

name - The name to set.

getDescription

java.lang.String getDescription()

A description of the promotion.

Returns:

Returns the description.

setDescription

void setDescription(java.lang.String description)

A description of the promotion.

Parameters:

description - The description to set.

getCategoryRule

int getCategoryRule()

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

Returns:

Returns the categoryRule.

setCategoryRule

void setCategoryRule(int categoryRule)

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

Parameters:

categoryRule - The categoryRule to set.

getCustomerRule

int getCustomerRule()

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

Returns:

Returns the customerRule.

setCustomerRule

void setCustomerRule(int customerRule)

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

Parameters:

customerRule - The customerRule to set.

getCustomerGroupRule

int getCustomerGroupRule()

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

Returns:

Returns the customerGroupRule.

setCustomerGroupRule

void setCustomerGroupRule(int customerGroupRule)

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

Parameters:

customerGroupRule - The customerGroupRule to set.

getManufacturerRule

int getManufacturerRule()

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

Returns:

Returns the manufacturerRule.

setManufacturerRule

void setManufacturerRule(int manufacturerRule)

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

Parameters:

manufacturerRule - The manufacturerRule to set.

getProductRule

int getProductRule()

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

Returns:

Returns the productRule.

setProductRule

void setProductRule(int productRule)

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

Parameters:

productRule - The productRule to set.

getApplicableProducts

OrderProductIf[] getApplicableProducts()

Contains an array of OrderProduct objects to which the promotion can be applied.

Returns:

Returns the applicableProducts.

setApplicableProducts

void setApplicableProducts(OrderProductIf[] applicableProducts)

Contains an array of OrderProduct objects to which the promotion can be applied.

Parameters:

applicableProducts - The applicableProducts to set.

getDateAdded

java.util.Calendar getDateAdded()

Returns:

Returns the dateAdded.

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - The dateAdded to set.

getEndDate

java.util.Calendar getEndDate()

After this date the promotion is no longer active.

Returns:

Returns the endDate.

setEndDate

void setEndDate(java.util.Calendar endDate)

After this date the promotion is no longer active.

Parameters:

endDate - The endDate to set.

getLastModified

java.util.Calendar getLastModified()

Returns:

Returns the lastModified.

setLastModified

void setLastModified(java.util.Calendar lastModified)

Parameters:

lastModified - The lastModified to set.

getStartDate

java.util.Calendar getStartDate()

Before this date the promotion is not active.

Returns:

Returns the startDate.

setStartDate

void setStartDate(java.util.Calendar startDate)

Before this date the promotion is not active.

Parameters:

startDate - The startDate to set.

getCoupon

CouponIf getCoupon()

There may be a coupon associated with the promotion.

Returns:

Returns the coupon.

setCoupon

void setCoupon(CouponIf coupon)

There may be a coupon associated with the promotion.

Parameters:

coupon - The coupon to set.

getMaxUse

int getMaxUse()

The maximum number of times that the promotion can be used by a single customer

Returns:

the maxUse

setMaxUse

void setMaxUse(int maxUse)

The maximum number of times that the promotion can be used by a single customer

Parameters:

maxUse - the maxUse to set

isRequiresCoupon

boolean isRequiresCoupon()

Does the promotion require a coupon

Returns:

Returns the requiresCoupon.

setRequiresCoupon

void setRequiresCoupon(boolean requiresCoupon)

Does the promotion require a coupon

Parameters:

requiresCoupon - The requiresCoupon to set.