com.konakart.bl

Class PromotionMgrEE

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.PromotionMgr

com.konakart.bl.PromotionMgrEE

All Implemented Interfaces:

PromotionMgrIf

public class PromotionMgrEE
extends PromotionMgr
implements PromotionMgrIf

Promotion Mgr - EE version.

Nested Class Summary

Nested classes/interfaces inherited from class com.konakart.bl.PromotionMgr

PromotionMgr.StaticData

Field Summary

Fields inherited from class com.konakart.bl.PromotionMgr

ALL, COUPON_DOESNT_EXIST, COUPON_EXISTS_ACTIVE, COUPON_EXISTS_INACTIVE, EXCLUDE, GIFT_CERTIFICATE_RELATION_TYPE, INCLUDE, log, mutex, PROMOTION_RELATION_TYPE, promotionUsageCountMaxRetries, promotionUseMutex, staticDataHM

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
PromotionMgrEE(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getProductMapKey(int prodId, int prodOptionId, int prodOptionValueId) Create a unique key for the Product Map
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.
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.

Methods inherited from class com.konakart.bl.PromotionMgr

applyDiscount, checkCategory, checkCoupon, checkCoupon, checkCoupon, checkCustomer, checkCustomerGroup, checkCustomerUse, checkExpression, checkManufacturer, checkProduct, checkPromotion, getAllPromotions, getCouponPerId, getCouponsPerCode, getCustomerId, getOrderProductsFromProduct, getPromotionCategoryMap, getPromotionCategoryMapKey, getPromotionExpressionMap, getPromotionIdForGiftCertificate, getPromotionIdForGiftCertificate, getPromotionManufacturerMap, getPromotionManufacturerMapKey, getPromotionProductMap, getPromotionProductMapKey, getPromotionResultArray, getPromotions, getPromotionsPerCoupon, getPromotionsPerOrderTotalCode, getPromotionsPerOrderTotalCode, getPromotionUsageCountMaxRetries, insertCoupon, isEnhancedVariantHandlingModeEnabled, processPrice, refreshConfigs, setCouponCriteriaWithStandardAttributes, setPromotionCriteriaWithStandardAttributes, setPromotionUsageCountMaxRetries, updatePromotionUsage, validateCoupon

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

Methods inherited from interface com.konakart.blif.PromotionMgrIf

checkCoupon, getAllPromotions, getCouponPerId, getCouponsPerCode, getPromotionIdForGiftCertificate, getPromotions, getPromotionsPerCoupon, getPromotionUsageCountMaxRetries, insertCoupon, refreshConfigs, setPromotionUsageCountMaxRetries, updatePromotionUsage

Constructor Detail

PromotionMgrEE

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

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

Overrides:

getPromotionsPerProducts in class PromotionMgr

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

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

Overrides:

getPromotion in class PromotionMgr

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

getProductMapKey

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

Create a unique key for the Product Map

Parameters:

prodId - the prodId

prodOptionId - the prodOptionId

prodOptionValueId - the prodOptionValueId

Returns:

Returns the key