com.konakart.bl

Class PromotionMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.PromotionMgr

All Implemented Interfaces:

PromotionMgrIf

Direct Known Subclasses:

PromotionMgrEE

public class PromotionMgr
extends BaseMgr
implements PromotionMgrIf

Promotions Manager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PromotionMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL Constant for Promotion Rule
static int	COUPON_DOESNT_EXIST Coupon doesn't exist
static int	COUPON_EXISTS_ACTIVE Coupon exists and is active
static int	COUPON_EXISTS_INACTIVE Coupon exists but is no longer active
static int	EXCLUDE Constant for Promotion Rule
protected static int	GIFT_CERTIFICATE_RELATION_TYPE Constant for Promotion To Product Relation
static int	INCLUDE Constant for Promotion Rule
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex mutex
protected static int	PROMOTION_RELATION_TYPE Constant for Promotion To Product Relation
protected static int	promotionUsageCountMaxRetries Number of times to retry the promotion usage count update SQL
protected static java.lang.String	promotionUseMutex Mutex for updating promotion usage count
protected static java.util.Map<java.lang.String,PromotionMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
PromotionMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	applyDiscount(ProductIf prod, PromotionResultIf promResult, PromotionOptionsIf options) Apply the promotion discount to a product
protected int	checkCategory(Promotion prm, ProductIf prod, java.util.HashMap<java.lang.String,java.lang.String> promotionCatMap, java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>> productCatIdMap) We check to see whether the product category is a category that can use the promotion.
protected int	checkCoupon(Promotion prm, Order order) If the promotion requires a coupon, we try and find one or more active coupons for the promotion that have a coupon code equal to the one in the order.
protected int	checkCoupon(Promotion prm, java.lang.String[] coupons) If the promotion requires a coupon, we try and find one or more active coupons for the promotion that have a coupon code equal to one of the ones the array.
int	checkCoupon(java.lang.String couponCode) This method is used to verify whether a coupon code actually exists and if it does, whether the coupon is still active.
protected int	checkCustomer(Promotion prm, int customerId) We check to see whether the customer submitting the order is a customer that can use the promotion.
protected int	checkCustomerGroup(Promotion prm, int customerId) We check to see whether the group of the customer submitting the order is a group that can use the promotion.
protected int	checkCustomerUse(Promotion prm, int customerId) If the promotion has the maxUse attribute set to a positive value, then we check to see whether the customer can still use the promotion or whether he has already used it the maximum number of times allowed.
protected int	checkExpression(Promotion prm, int customerId, java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>> expressionIdMap) We check to see whether the expression evaluates to TRUE
protected int	checkManufacturer(Promotion prm, ProductIf prod, java.util.HashMap<java.lang.String,java.lang.String> promotionManuMap) We check to see whether the product manufacturer is a manufacturer that can use the promotion.
protected int	checkProduct(Promotion prm, OrderProductIf orderProd, java.util.HashMap<java.lang.String,PromotionProduct> promotionProdMap) We check to see whether the product is a product that can use the promotion.
protected boolean	checkPromotion(Promotion prm) Checks the validity of the promotion object.
Promotion[]	getAllPromotions() Returns an array of all active promotions
Coupon	getCouponPerId(int couponId, CouponOptionsIf options) Returns a coupon for the coupon id passed in as a parameter.
Coupon[]	getCouponsPerCode(java.lang.String couponCode, CouponOptionsIf options) Returns an array of coupons for the coupon code passed in as a parameter.
protected int	getCustomerId(java.lang.String sessionId, int customerId) If the sessionId is null, we check the customerId to ensure that it is negative.
protected OrderProduct[]	getOrderProductsFromProduct(ProductIf prod) Creates OrderProducts from a product so that we can reuse the checkProduct() method.
PromotionIf	getPromotion(int promotionId, java.lang.String promotionName, int languageId, FetchPromotionOptionsIf prmOptions, FetchProductOptionsIf prodOptions) This API call is used to retrieve a single promotion matching an id or name.
protected java.util.HashMap<java.lang.String,java.lang.String>	getPromotionCategoryMap(PromotionIf[] activePromotions) Create a hash map of all of the categories associated with the active promotions with a single database query
protected java.lang.String	getPromotionCategoryMapKey(int promotionId, int catId) Create a unique key for the Promotion Category Map
protected java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>>	getPromotionExpressionMap(PromotionIf[] activePromotions) Create a hash map of all of the expressions associated with the active promotions with a single database query
protected int	getPromotionIdForGiftCertificate(int productId, int productOptionId, int productOptionValueId) Protected method for common code to get the promotion id of a promotion connected to a gift certificate.
int	getPromotionIdForGiftCertificate(OrderProductIf op) Get the promotion id for an order product object containing a gift certificate.
protected java.util.HashMap<java.lang.String,java.lang.String>	getPromotionManufacturerMap(PromotionIf[] activePromotions) Create a hash map of all of the manufacturers associated with the active promotions with a single database query
protected java.lang.String	getPromotionManufacturerMapKey(int promotionId, int manuId) Create a unique key for the Promotion Manufacturer Map
protected java.util.HashMap<java.lang.String,PromotionProduct>	getPromotionProductMap(PromotionIf[] activePromotions, Order order, ProductIf[] products) Create a hash map of all of the products associated with the active promotions with a single database query.
protected java.lang.String	getPromotionProductMapKey(int promotionId, int prodId, int prodOptionId, int prodOptionValueId) Create a unique key for the Promotion Product Map
protected PromotionResultIf[]	getPromotionResultArray(PromotionResultIf[] currentArray, PromotionResult newResult) Utility method to add a PromotionResult object on to the end of an array
Promotion[]	getPromotions(java.lang.String orderTotalCode, Order order) We return all active promotions for the orderTotalCode passed in as a parameter.
Promotion[]	getPromotionsPerCoupon(java.lang.String couponCode, int couponId, PromotionOptionsIf options) This method is used to return an array of promotions associated with the coupon(s) identified by the input parameters.
protected Promotion[]	getPromotionsPerOrderTotalCode(java.util.ArrayList<java.lang.String> orderTotalCodeList) The active promotions related to the list of orderTotalCodes passed in as a parameter, are fetched from the database and returned.
protected Promotion[]	getPromotionsPerOrderTotalCode(java.lang.String orderTotalCode) The active promotions related to the list of orderTotalCodes passed in as a parameter, are fetched from the database and returned.
ProductIf[]	getPromotionsPerProducts(java.lang.String sessionId, int customerId, ProductIf[] products, PromotionIf[] promotions, java.lang.String[] couponCodes, PromotionOptionsIf options) This method is used to calculate a discount on individual products so that the discount can be displayed without having to add the product to the cart. The method receives an array of products and returns an array of products with attached PromotionResult objects that contain the results of one or more of the promotions passed in as a parameter.
int	getPromotionUsageCountMaxRetries()
int	insertCoupon(CouponIf coupon, int promotionId) Insert a coupon and associate it with the promotion referenced by promotionId.
protected boolean	isEnhancedVariantHandlingModeEnabled() Check in the static data if enhanced variant handling mode is enabled.
protected void	processPrice(ProductIf prod, PromotionOptionsIf options) We apply the discount to a product, taking into consideration the rules to decide which promotion discount to select
void	refreshConfigs() Refresh the configuration of the Promotion manager
protected void	setCouponCriteriaWithStandardAttributes(KKCriteria c) Set the criteria object with all of the attributes for a coupon
protected void	setPromotionCriteriaWithStandardAttributes(KKCriteria c) Set the criteria object with all of the attributes for a promotion
void	setPromotionUsageCountMaxRetries(int promotionUsageCountMaxRetries) The maximum number of optimistic concurrency retries when setting the promotion usage count
void	updatePromotionUsage(Order order) If the order has any associated coupons we iterate through the coupons and increment the timesUsed attribute.
protected void	validateCoupon(CouponIf coupon) Used to validate a coupon before inserting

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

mutex

staticDataHM

protected static java.util.Map<java.lang.String,PromotionMgr.StaticData> staticDataHM

Hash Map that contains the static data

ALL

public static final int ALL

Constant for Promotion Rule

See Also:

Constant Field Values

EXCLUDE

public static final int EXCLUDE

Constant for Promotion Rule

See Also:

Constant Field Values

INCLUDE

public static final int INCLUDE

Constant for Promotion Rule

See Also:

Constant Field Values

PROMOTION_RELATION_TYPE

protected static final int PROMOTION_RELATION_TYPE

Constant for Promotion To Product Relation

See Also:

Constant Field Values

GIFT_CERTIFICATE_RELATION_TYPE

protected static final int GIFT_CERTIFICATE_RELATION_TYPE

Constant for Promotion To Product Relation

See Also:

Constant Field Values

COUPON_DOESNT_EXIST

public static final int COUPON_DOESNT_EXIST

Coupon doesn't exist

See Also:

Constant Field Values

COUPON_EXISTS_ACTIVE

public static final int COUPON_EXISTS_ACTIVE

Coupon exists and is active

See Also:

Constant Field Values

COUPON_EXISTS_INACTIVE

public static final int COUPON_EXISTS_INACTIVE

Coupon exists but is no longer active

See Also:

Constant Field Values

promotionUsageCountMaxRetries

protected static int promotionUsageCountMaxRetries

Number of times to retry the promotion usage count update SQL

promotionUseMutex

protected static java.lang.String promotionUseMutex

Mutex for updating promotion usage count

Constructor Detail

PromotionMgr

public PromotionMgr(KKEngIf eng)
             throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getPromotions

public Promotion[] getPromotions(java.lang.String orderTotalCode,
                                 Order order)
                          throws java.lang.Exception

We return all active promotions for the orderTotalCode passed in as a parameter. The promotion may only apply for a subset of the products within the order so we return this information as an attribute of the Promotion object.

Specified by:

getPromotions in interface PromotionMgrIf

Parameters:

orderTotalCode - the orderTotalCode

order - the order

Returns:

An array of promotion objects

Throws:

java.lang.Exception - an unexpected exception

getAllPromotions

public Promotion[] getAllPromotions()
                             throws java.lang.Exception

Returns an array of all active promotions

Specified by:

getAllPromotions in interface PromotionMgrIf

Returns:

Returns an array of all active promotions

Throws:

java.lang.Exception - an unexpected exception

checkPromotion

protected boolean checkPromotion(Promotion prm)

Checks the validity of the promotion object.

Parameters:

prm - the prm

Returns:

Returns true if valid. Otherwise false.

checkCustomer

protected int checkCustomer(Promotion prm,
                            int customerId)
                     throws com.workingdogs.village.DataSetException,
                            org.apache.torque.TorqueException

We check to see whether the customer submitting the order is a customer that can use the promotion. He may have to be included explicitly or may have been excluded.

Parameters:

prm - the prm

customerId - the customerId

Returns:

Returns 0 if the customer can use the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkCustomerUse

protected int checkCustomerUse(Promotion prm,
                               int customerId)
                        throws com.workingdogs.village.DataSetException,
                               org.apache.torque.TorqueException

If the promotion has the maxUse attribute set to a positive value, then we check to see whether the customer can still use the promotion or whether he has already used it the maximum number of times allowed.

Parameters:

prm - the prm

customerId - the customerId

Returns:

Returns 0 if the customer can use the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkCustomerGroup

protected int checkCustomerGroup(Promotion prm,
                                 int customerId)
                          throws java.lang.Exception

We check to see whether the group of the customer submitting the order is a group that can use the promotion.

Parameters:

prm - the prm

customerId - the customerId

Returns:

Returns 0 if the customer can use the promotion. Otherwise a negative number.

Throws:

java.lang.Exception - an unexpected exception

checkManufacturer

protected int checkManufacturer(Promotion prm,
                                ProductIf prod,
                                java.util.HashMap<java.lang.String,java.lang.String> promotionManuMap)
                         throws com.workingdogs.village.DataSetException,
                                org.apache.torque.TorqueException

We check to see whether the product manufacturer is a manufacturer that can use the promotion.

Parameters:

prm - the prm

prod - the prod

promotionManuMap - the promotionManuMap

Returns:

Returns 0 if the manufacturer can use the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getPromotionProductMap

protected java.util.HashMap<java.lang.String,PromotionProduct> getPromotionProductMap(PromotionIf[] activePromotions,
                                                                                      Order order,
                                                                                      ProductIf[] products)
                                                                               throws com.workingdogs.village.DataSetException,
                                                                                      org.apache.torque.TorqueException

Create a hash map of all of the products associated with the active promotions with a single database query. An array of products used in the query is determined from the order parameter if not null. Otherwise from the products parameter.

Parameters:

activePromotions - the activePromotions

order - the order

products - the products

Returns:

Returns a promotion product map

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getPromotionProductMapKey

protected java.lang.String getPromotionProductMapKey(int promotionId,
                                                     int prodId,
                                                     int prodOptionId,
                                                     int prodOptionValueId)

Create a unique key for the Promotion Product Map

Parameters:

promotionId - the promotionId

prodId - the prodId

prodOptionId - the prodOptionId

prodOptionValueId - the prodOptionValueId

Returns:

Returns the key

getPromotionManufacturerMap

protected java.util.HashMap<java.lang.String,java.lang.String> getPromotionManufacturerMap(PromotionIf[] activePromotions)
                                                                                    throws com.workingdogs.village.DataSetException,
                                                                                           org.apache.torque.TorqueException

Create a hash map of all of the manufacturers associated with the active promotions with a single database query

Parameters:

activePromotions - the activePromotions

Returns:

Returns a promotion manufacturer map

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getPromotionManufacturerMapKey

protected java.lang.String getPromotionManufacturerMapKey(int promotionId,
                                                          int manuId)

Create a unique key for the Promotion Manufacturer Map

Parameters:

promotionId - the promotionId

manuId - the manuId

Returns:

Returns the key

getPromotionCategoryMap

protected java.util.HashMap<java.lang.String,java.lang.String> getPromotionCategoryMap(PromotionIf[] activePromotions)
                                                                                throws java.lang.Exception

Create a hash map of all of the categories associated with the active promotions with a single database query

Parameters:

activePromotions - the activePromotions

Returns:

Returns a promotion category map

Throws:

java.lang.Exception - an unexpected exception

getPromotionCategoryMapKey

protected java.lang.String getPromotionCategoryMapKey(int promotionId,
                                                      int catId)

Create a unique key for the Promotion Category Map

Parameters:

promotionId - the promotionId

catId - the catId

Returns:

Returns the key

getPromotionExpressionMap

protected java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>> getPromotionExpressionMap(PromotionIf[] activePromotions)
                                                                                                         throws com.workingdogs.village.DataSetException,
                                                                                                                org.apache.torque.TorqueException

Create a hash map of all of the expressions associated with the active promotions with a single database query

Parameters:

activePromotions - the activePromotions

Returns:

Returns a hash map containing a list of expression ids for each promotion id

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkProduct

protected int checkProduct(Promotion prm,
                           OrderProductIf orderProd,
                           java.util.HashMap<java.lang.String,PromotionProduct> promotionProdMap)
                    throws com.workingdogs.village.DataSetException,
                           org.apache.torque.TorqueException

We check to see whether the product is a product that can use the promotion. The order product may contain an array of options so we have to consider each option separately.

Parameters:

prm - the prm

orderProd - the orderProd

promotionProdMap - the promotionProdMap

Returns:

Returns 0 if the orderProd can use the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkCategory

protected int checkCategory(Promotion prm,
                            ProductIf prod,
                            java.util.HashMap<java.lang.String,java.lang.String> promotionCatMap,
                            java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>> productCatIdMap)
                     throws java.lang.Exception

We check to see whether the product category is a category that can use the promotion.

Parameters:

prm - the prm

prod - the prod

promotionCatMap - the promotionCatMap

productCatIdMap - the productCatIdMap

Returns:

Returns 0 if the category can use the promotion. Otherwise a negative number.

Throws:

java.lang.Exception - an unexpected exception

checkCoupon

protected int checkCoupon(Promotion prm,
                          Order order)
                   throws com.workingdogs.village.DataSetException,
                          org.apache.torque.TorqueException

If the promotion requires a coupon, we try and find one or more active coupons for the promotion that have a coupon code equal to the one in the order. When we find a valid coupon, we attach it to the promotion.

Parameters:

prm - the prm

order - the order

Returns:

Returns 0 if the order coupon code matches a valid active coupon for the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkCoupon

protected int checkCoupon(Promotion prm,
                          java.lang.String[] coupons)
                   throws com.workingdogs.village.DataSetException,
                          org.apache.torque.TorqueException

If the promotion requires a coupon, we try and find one or more active coupons for the promotion that have a coupon code equal to one of the ones the array. When we find a valid coupon, we attach it to the promotion.

Parameters:

prm - the prm

coupons - the coupons

Returns:

Returns 0 if the coupon code matches a valid active coupon for the promotion. Otherwise a negative number.

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

checkExpression

protected int checkExpression(Promotion prm,
                              int customerId,
                              java.util.HashMap<java.lang.Integer,java.util.ArrayList<java.lang.Integer>> expressionIdMap)
                       throws java.lang.Exception

We check to see whether the expression evaluates to TRUE

Parameters:

prm - the prm

customerId - the customerId

expressionIdMap - the expressionIdMap

Returns:

Returns 0 if the expression evaluates to TRUE or doesn't exist. Otherwise a negative number.

Throws:

java.lang.Exception - an unexpected exception

getPromotionsPerOrderTotalCode

protected Promotion[] getPromotionsPerOrderTotalCode(java.lang.String orderTotalCode)
                                              throws java.lang.Exception

The active promotions related to the list of orderTotalCodes passed in as a parameter, are fetched from the database and returned.

Parameters:

orderTotalCode - the orderTotalCode

Returns:

Returns an array of promotion objects

Throws:

java.lang.Exception - an unexpected exception

getPromotionsPerOrderTotalCode

protected Promotion[] getPromotionsPerOrderTotalCode(java.util.ArrayList<java.lang.String> orderTotalCodeList)
                                              throws java.lang.Exception

The active promotions related to the list of orderTotalCodes passed in as a parameter, are fetched from the database and returned.

Parameters:

orderTotalCodeList - the orderTotalCodeList

Returns:

Returns an array of promotion objects

Throws:

java.lang.Exception - an unexpected exception

updatePromotionUsage

public void updatePromotionUsage(Order order)
                          throws java.lang.Exception

If the order has any associated coupons we iterate through the coupons and increment the timesUsed attribute. If the order has any associated promotions that were linked to the customer directly through the promotion_to_customer table, then we retrieve these records and increment the timesUsed attribute.

Specified by:

updatePromotionUsage in interface PromotionMgrIf

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception

setPromotionCriteriaWithStandardAttributes

protected void setPromotionCriteriaWithStandardAttributes(KKCriteria c)

Set the criteria object with all of the attributes for a promotion

Parameters:

c - the c

setCouponCriteriaWithStandardAttributes

protected void setCouponCriteriaWithStandardAttributes(KKCriteria c)

Set the criteria object with all of the attributes for a coupon

Parameters:

c - the c

getPromotionIdForGiftCertificate

public int getPromotionIdForGiftCertificate(OrderProductIf op)
                                     throws com.konakart.app.KKException,
                                            org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Get the promotion id for an order product object containing a gift certificate. A negative id is returned if a promotion doesn't exist.

Specified by:

getPromotionIdForGiftCertificate in interface PromotionMgrIf

Parameters:

op - the op

Returns:

Returns the id of the promotion or -1 if a promotion doesn't exist.

Throws:

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getPromotionIdForGiftCertificate

protected int getPromotionIdForGiftCertificate(int productId,
                                               int productOptionId,
                                               int productOptionValueId)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException

Protected method for common code to get the promotion id of a promotion connected to a gift certificate. There should only be one promotion.

Parameters:

productId - the productId

productOptionId - the productOptionId

productOptionValueId - the productOptionValueId

Returns:

Returns the id of the promotion

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

insertCoupon

public int insertCoupon(CouponIf coupon,
                        int promotionId)
                 throws java.lang.Exception

Insert a coupon and associate it with the promotion referenced by promotionId. If the promotionId is a negative number then no association is done.

Specified by:

insertCoupon in interface PromotionMgrIf

Parameters:

coupon - the coupon

promotionId - the promotionId

Returns:

Returns the couponId

Throws:

java.lang.Exception - an unexpected exception

validateCoupon

protected void validateCoupon(CouponIf coupon)
                       throws com.konakart.app.KKException

Used to validate a coupon before inserting

Parameters:

coupon - the coupon

Throws:

com.konakart.app.KKException - an unexpected KKException exception

checkCoupon

public int checkCoupon(java.lang.String couponCode)
                throws com.workingdogs.village.DataSetException,
                       org.apache.torque.TorqueException

This method is used to verify whether a coupon code actually exists and if it does, whether the coupon is still active. Valid return values for this method are:

• com.konakart.bl.PromotionMgr.COUPON_DOESNT_EXIST - The coupon code does not exist.
• com.konakart.bl.PromotionMgr.COUPON_EXISTS_ACTIVE - The coupon code does exist and the coupon is still active.
• com.konakart.bl.PromotionMgr.COUPON_EXISTS_INACTIVE - The coupon code does exist but the coupon is no longer active since the number of times it has been used has reached the maximum number of times allowed.

Even if the coupon exists and is active, it won't actually do anything if it isn't connected to a valid promotion and any rules associated with the promotion are also satisfied. However, this method may still be used to at least warn a customer that he may have mistyped the coupon code or that it is no longer valid.

Specified by:

checkCoupon in interface PromotionMgrIf

Parameters:

couponCode - The coupon code

Returns:

Returns an integer

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getPromotionsPerProducts

public ProductIf[] getPromotionsPerProducts(java.lang.String sessionId,
                                            int customerId,
                                            ProductIf[] products,
                                            PromotionIf[] promotions,
                                            java.lang.String[] couponCodes,
                                            PromotionOptionsIf options)
                                     throws java.lang.Exception

This method is used to calculate a discount on individual products so that the discount can be displayed without having to add the product to the cart.
The method receives an array of products and returns an array of products with attached PromotionResult objects that contain the results of one or more of the promotions passed in as a parameter. The PromotionResult contains the value of the discount, whether it is an amount or a percentage discount and also information regarding the promotion it applies to. If a product has an array of ProductQuantity objects (one for each SKU) each one of these may have an array of PromotionResult objects since a promotion may only apply to one product configuration and not to another (i.e. blue shirt and not red shirt).
The PromotionOptions object can be configured so that the values of the promotions for a product are subtracted from the product price. The options allow you to set rules that determine whether in this case the promotions need to be cumulative or whether the largest or smallest should be chosen. The calculation is only made for products with a single array of PromotionResult objects. It is not calculated for products that have an array of PromotionResult objects for each ProductQuantity.

Specified by:

getPromotionsPerProducts in interface PromotionMgrIf

Parameters:

sessionId - Only used if the customer is logged in. Otherwise set to null.

customerId - If the sessionId is set to null then the customerId should contain the id of the temporary user which is a negative number. The temporary user id can be used for evaluating expression rules.

products - An array of products to be processed

promotions - The promotions which will be applied to the products if all rules are matched.

couponCodes - Coupon codes to use. If none of the promotions require coupons, it should be set to null

options - An object containing information to configure the calculation for applying one or more promotion results to the product price.

Returns:

Returns the same array of products passed in as a parameter with attached PromotionResult objects if applicable

Throws:

java.lang.Exception - an unexpected exception

processPrice

protected void processPrice(ProductIf prod,
                            PromotionOptionsIf options)

We apply the discount to a product, taking into consideration the rules to decide which promotion discount to select

Parameters:

prod - the prod

options - the options

applyDiscount

protected void applyDiscount(ProductIf prod,
                             PromotionResultIf promResult,
                             PromotionOptionsIf options)

Apply the promotion discount to a product

Parameters:

prod - the prod

promResult - the promResult

options - the options

getPromotionResultArray

protected PromotionResultIf[] getPromotionResultArray(PromotionResultIf[] currentArray,
                                                      PromotionResult newResult)

Utility method to add a PromotionResult object on to the end of an array

Parameters:

currentArray - the currentArray

newResult - the newResult

Returns:

Returns an array of PromotionResult objects

getOrderProductsFromProduct

protected OrderProduct[] getOrderProductsFromProduct(ProductIf prod)
                                              throws java.lang.Exception

Creates OrderProducts from a product so that we can reuse the checkProduct() method.

Parameters:

prod - the prod

Returns:

Returns an array of OrderProduct objects

Throws:

java.lang.Exception - an unexpected exception

getCustomerId

protected int getCustomerId(java.lang.String sessionId,
                            int customerId)
                     throws java.lang.Exception

If the sessionId is null, we check the customerId to ensure that it is negative. If it is negative, this means that it is a non registered customer or a customer that hasn't logged in yet and so there is no customer mapped to the session id. Otherwise we ensure that the sessionId is valid and we don't use the customerId because we get the id from the session.

Parameters:

sessionId - the sessionId

customerId - the customerId

Returns:

Returns the customerId that should be used by the caller

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Description copied from interface: PromotionMgrIf

Refresh the configuration of the Promotion manager

Specified by:

refreshConfigs in interface PromotionMgrIf

Throws:

java.lang.Exception - an unexpected exception

getCouponsPerCode

public Coupon[] getCouponsPerCode(java.lang.String couponCode,
                                  CouponOptionsIf options)
                           throws java.lang.Exception

Returns an array of coupons for the coupon code passed in as a parameter.

The options object allows you to specify that only active coupons should be returned.

Specified by:

getCouponsPerCode in interface PromotionMgrIf

Parameters:

couponCode - the couponCode

options - Allows you to specify that only active coupons should be returned

Returns:

Returns an array of coupons. An empty array is returned if no coupons are available.

Throws:

java.lang.Exception - an unexpected exception

getCouponPerId

public Coupon getCouponPerId(int couponId,
                             CouponOptionsIf options)
                      throws java.lang.Exception

Returns a coupon for the coupon id passed in as a parameter.

The options object allows you to specify that only active coupons should be returned.

Specified by:

getCouponPerId in interface PromotionMgrIf

Parameters:

couponId - the couponId

options - Allows you to specify that only active coupons should be returned

Returns:

Returns a coupon object or null if a coupon isn't available.

Throws:

java.lang.Exception - an unexpected exception

getPromotionsPerCoupon

public Promotion[] getPromotionsPerCoupon(java.lang.String couponCode,
                                          int couponId,
                                          PromotionOptionsIf options)
                                   throws java.lang.Exception

This method is used to return an array of promotions associated with the coupon(s) identified by the input parameters. The method will either use the couponCode or the couponId parameter. The couponCode is used if not null, otherwise couponId is used. Note that multiple coupons may share the same coupon code.

The PromotionOptions may be used to control whether or not to use expired coupons and whether or not to return expired promotions. The default is to not check whether coupons or promotions have expired.

If no promotions are found, an empty array is returned.

Specified by:

getPromotionsPerCoupon in interface PromotionMgrIf

Parameters:

couponCode - The code of the coupon

couponId - The unique numeric id of the coupon

options - A PromotionOptions object to control whether or not to use expired coupons and whether or not to return expired promotions

Returns:

Returns an array of promotions

Throws:

java.lang.Exception - an unexpected exception

getPromotionUsageCountMaxRetries

public int getPromotionUsageCountMaxRetries()

Specified by:

getPromotionUsageCountMaxRetries in interface PromotionMgrIf

Returns:

Returns the maximum number of optimistic concurrency retries when setting the promotion usage count

setPromotionUsageCountMaxRetries

public void setPromotionUsageCountMaxRetries(int promotionUsageCountMaxRetries)

The maximum number of optimistic concurrency retries when setting the promotion usage count

Specified by:

setPromotionUsageCountMaxRetries in interface PromotionMgrIf

Parameters:

promotionUsageCountMaxRetries - the promotionUsageCountMaxRetries to set

getPromotion

public PromotionIf getPromotion(int promotionId,
                                java.lang.String promotionName,
                                int languageId,
                                FetchPromotionOptionsIf prmOptions,
                                FetchProductOptionsIf prodOptions)
                         throws java.lang.Exception

This API call is used to retrieve a single promotion matching an id or name. Depending on how the options are configured, the returned object may have its arrays of included / excluded products, categories and manufacturers populated. If a product has options (variants) then we return the product populated with all of the options that are included or excluded for the promotion.

The purpose of this method is mainly to determine what products, manufacturers or categories are included or excluded from the promotion in order to be able to display this information on the storefront. However if the FetchPromotionOptions is configured to only return the promotion if active, then we check the following:

• That the promotion is active.
• That the current time is within the configured date range of the promotion.
• That the promotion hasn't reached its max usage limit.
• If the couponCodes attribute of the FetchPromotionOptions object has been populated and the promotion requires a coupon then we check that at least one coupon will activate the promotion.
• That the customer hasn't been excluded from the promotion.
• That the customer hasn't reached his personal max usage limit.
• That the customer group isn't excluded from the promotion.
• That any one expression attached to the promotion evaluates to true.

Specified by:

getPromotion in interface PromotionMgrIf

Parameters:

promotionId - The numeric id of the promotion used to identify it. It should be set to a negative number in order to search for the promotion using the promotion name.

promotionName - If not set to null, the promotion name is used to search for the promotion instead of the numeric id.

languageId - The id for the language that will be used when creating the attached products, categories and manufacturers. Value of -1 selects the default language.

prmOptions - A FetchPromotionOptions object used to configure the API call. It may be set to null for default functionality.

prodOptions - A FetchProductOptions used to configure the products (if any) attached to the promotion. It may be set to null for default functionality.

Returns:

Returns a fully populated promotion object

Throws:

java.lang.Exception - an unexpected exception

isEnhancedVariantHandlingModeEnabled

protected boolean isEnhancedVariantHandlingModeEnabled()
                                                throws com.konakart.app.KKException

Check in the static data if enhanced variant handling mode is enabled.

Returns:

true if is enabled

Throws:

com.konakart.app.KKException - an unexpected KKException exception