com.konakart.json.app
Class J_Promotion

java.lang.Object
  com.konakart.json.app.J_Promotion

All Implemented Interfaces:

java.io.Serializable

public class J_Promotion
extends java.lang.Object
implements java.io.Serializable

The Promotion object contains information about the promotion.

See Also:

Serialized Form

Constructor Summary

J_Promotion()

Method Summary

J_OrderProduct[]	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.
J_Coupon	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(J_OrderProduct[] _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(J_Coupon _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.

Methods inherited from class java.lang.Object

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

Constructor Detail

J_Promotion

public J_Promotion()

Method Detail

isActive

public boolean isActive()

Set to true if the promotion is active.

Returns:

Returns the active.

setActive

public void setActive(boolean _active)

Set to true if the promotion is active.

Parameters:

_active - The active to set.

isCumulative

public 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

public 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

public java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

public void setCustom4(java.lang.String _custom4)

Parameters:

_custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

public void setCustom5(java.lang.String _custom5)

Parameters:

_custom5 - The custom5 to set.

getCustom6

public java.lang.String getCustom6()

Returns:

Returns the custom6.

setCustom6

public void setCustom6(java.lang.String _custom6)

Parameters:

_custom6 - The custom6 to set.

getCustom7

public java.lang.String getCustom7()

Returns:

Returns the custom7.

setCustom7

public void setCustom7(java.lang.String _custom7)

Parameters:

_custom7 - The custom7 to set.

getCustom8

public java.lang.String getCustom8()

Returns:

Returns the custom8.

setCustom8

public void setCustom8(java.lang.String _custom8)

Parameters:

_custom8 - The custom8 to set.

getCustom9

public java.lang.String getCustom9()

Returns:

Returns the custom9.

setCustom9

public void setCustom9(java.lang.String _custom9)

Parameters:

_custom9 - The custom9 to set.

getCustom10

public java.lang.String getCustom10()

Returns:

Returns the custom10.

setCustom10

public void setCustom10(java.lang.String _custom10)

Parameters:

_custom10 - The custom10 to set.

getId

public int getId()

Returns:

Returns the id.

setId

public void setId(int _id)

Parameters:

_id - The id to set.

getOrderTotalCode

public java.lang.String getOrderTotalCode()

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

Returns:

Returns the orderTotalCode.

setOrderTotalCode

public 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

public java.lang.String getName()

The promotion name.

Returns:

Returns the name.

setName

public void setName(java.lang.String _name)

The promotion name.

Parameters:

_name - The name to set.

getDescription

public java.lang.String getDescription()

A description of the promotion.

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String _description)

A description of the promotion.

Parameters:

_description - The description to set.

getCategoryRule

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public J_OrderProduct[] getApplicableProducts()

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

Returns:

Returns the applicableProducts.

setApplicableProducts

public void setApplicableProducts(J_OrderProduct[] _applicableProducts)

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

Parameters:

_applicableProducts - The applicableProducts to set.

getDateAdded

public java.util.Calendar getDateAdded()

Returns:

Returns the dateAdded.

setDateAdded

public void setDateAdded(java.util.Calendar _dateAdded)

Parameters:

_dateAdded - The dateAdded to set.

getEndDate

public java.util.Calendar getEndDate()

After this date the promotion is no longer active.

Returns:

Returns the endDate.

setEndDate

public void setEndDate(java.util.Calendar _endDate)

After this date the promotion is no longer active.

Parameters:

_endDate - The endDate to set.

getLastModified

public java.util.Calendar getLastModified()

Returns:

Returns the lastModified.

setLastModified

public void setLastModified(java.util.Calendar _lastModified)

Parameters:

_lastModified - The lastModified to set.

getStartDate

public java.util.Calendar getStartDate()

Before this date the promotion is not active.

Returns:

Returns the startDate.

setStartDate

public void setStartDate(java.util.Calendar _startDate)

Before this date the promotion is not active.

Parameters:

_startDate - The startDate to set.

getCoupon

public J_Coupon getCoupon()

There may be a coupon associated with the promotion.

Returns:

Returns the coupon.

setCoupon

public void setCoupon(J_Coupon _coupon)

There may be a coupon associated with the promotion.

Parameters:

_coupon - The coupon to set.

getMaxUse

public int getMaxUse()

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

Returns:

the maxUse

setMaxUse

public 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

public boolean isRequiresCoupon()

Does the promotion require a coupon

Returns:

Returns the requiresCoupon.

setRequiresCoupon

public void setRequiresCoupon(boolean _requiresCoupon)

Does the promotion require a coupon

Parameters:

_requiresCoupon - The requiresCoupon to set.