com.konakartadmin.bl

Class AdminPromotionMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminPromotionMgr

All Implemented Interfaces:

AdminPromotionMgrIf

Direct Known Subclasses:

AdminPromotionMgrEE

public class AdminPromotionMgr
extends AdminBaseMgr
implements AdminPromotionMgrIf

The AdminPromotionMgr - for Managing Promotions for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminPromotionMgr.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	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 java.util.Map<java.lang.String,AdminPromotionMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminPromotionMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addCategoriesToPromotion(AdminCategory[] categories, int promotionId, int rule) Add the array of categories to the promotion
protected void	addCouponOrderBy(com.konakart.db.KKCriteria c, AdminCouponSearch search) Add order by constraints to query
protected int	addCouponSearchCriteria(com.konakart.db.KKCriteria c, AdminCouponSearch couponSearch) Add search criteria to query
void	addCouponsToPromotion(AdminCoupon[] coupons, int promotionId) Add the array of coupons to the promotion.
void	addCustomerGroupsToPromotion(int[] groupIds, int promotionId, int rule) Add customers to the promotion belonging to the groups in the array of group ids.
void	addCustomersToPromotion(AdminCustomer[] customers, int promotionId, int rule, int maxUse) Add the array of customers to the promotion
void	addCustomersToPromotion(java.util.Calendar lastOrderDate, boolean havePlacedOrder, int promotionId, int rule, int maxUse) Add to the promotion identified by promotionId, the customers who have or haven't placed an order since the lastOrderDate passed in as a parameter.
void	addExpressionsToPromotion(AdminExpression[] expressions, int promotionId) Add the array of expressions to the promotion
void	addGiftCertificatesToPromotion(AdminProduct[] giftCertificates, int promotionId) Associates the gift certificate products with the promotion.
void	addManufacturersToPromotion(AdminManufacturer[] manufacturers, int promotionId, int rule) Add the array of manufacturers to the promotion
void	addProductsToPromotion(AdminProduct[] products, int promotionId, int rule) Add the array of products to the promotion.
protected void	addProductsToPromotion(AdminProduct[] products, int promotionId, int rule, boolean giftCertificate) Add the array of products to the promotion.
protected void	addPromotionOrderBy(com.konakart.db.KKCriteria c, AdminPromotionSearch search) Add order by constraints to query
protected int	addPromotionSearchCriteria(com.konakart.db.KKCriteria c, AdminPromotionSearch promSearch) Add search criteria to query
void	addPromotionsToCoupon(AdminPromotion[] promotions, int couponId) Add the array of promotions to the coupon.
protected void	addTestExpressionToPromotion(int promotionId) Adds the promotion test expression to the promotion.
void	deleteCoupon(int couponId) The coupon is deleted along with any entries in the promotion to coupon table.
protected void	deleteCouponsPerPromotion(int promotionId) If a coupon belongs to only this promotion it is deleted, otherwise just the entry in the promotion to products table is deleted
void	deletePromotion(int promotionId) Delete the promotion referenced to by promotionId.
protected void	deletePromotionCommonCode(int promotionId, com.konakart.db.KKCriteria deleteC, java.sql.Connection con) Method to avoid code duplication
void	deletePromotionWithOptions(int promotionId, AdminDeletePromotionOptions options) Delete the promotion referenced to by promotionId.
void	editCoupon(AdminCoupon coupon) Edits the coupon
void	editPromotion(AdminPromotion promotion) Edits the promotion
protected int	getCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
AdminCouponSearchResult	getCoupons(AdminCouponSearch search, int offset, int size) This returns an AdminCouponSearchResult object.
int	getCouponsCount(AdminCouponSearch search) Returns a count of the number of Coupons
AdminCoupon[]	getCouponsPerPromotion(int promotionId) Get an array of Admin coupon objects for a promotion
int	getCustomersCountWhoHaventPlacedAnOrderSince(java.util.Calendar lastOrderDate) Return the count of the number of customers who haven't placed an order since the lastOrderDate passed in as a parameter.
int	getCustomersCountWhoHavePlacedAnOrderSince(java.util.Calendar lastOrderDate) Return the count of the number of customers who have placed an order since the lastOrderDate passed in as a parameter.
AdminProducts	getGiftCertificatesPerPromotion(AdminProductSearch search, int offset, int size) Get an array of Admin product gift certificate objects for a promotion.
protected AdminOption[]	getProductOptionsPerProductAndPromotion(int promotionId, int productId, boolean giftCertificate) We return an array of AminOption objects for every product option and value in the promotion.
AdminProducts	getProductsPerPromotion(AdminProductSearch search, int offset, int size) Get an array of Admin product objects for a promotion.
protected AdminProducts	getProductsPerPromotion(AdminProductSearch search, int offset, int size, boolean giftCertificate) Get an array of Admin product objects for a promotion.
AdminPromotion	getPromotion(int id, boolean includeCoupons, boolean includeStats) Get a promotion object and an array of associated coupon objects
int	getPromotionIdForGiftCertificate(AdminOrderProduct op) Get the promotion id for an order product object containing a gift certificate.
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.
AdminPromotionSearchResult	getPromotions(AdminPromotionSearch search, int offset, int size) This returns an AdminPromotionSearchResult object.
int	getPromotionsCount(AdminPromotionSearch search) Returns a count of the number of Promotions
AdminPromotion[]	getPromotionsPerCoupon(int couponId) Get an array of Admin promotion objects for a coupon
java.util.Calendar	getStoreTime() Returns the local store time based on the tz database time zone of the store.
protected int	getTestExpressionId()
int	insertCoupon(AdminCoupon coupon) Inserts a coupon
int	insertCoupon(AdminCoupon coupon, int promotionId) Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion
protected int	insertCoupon(AdminCoupon coupon, int promotionId, java.sql.Connection connection) Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion
int	insertPromotion(AdminPromotion prom) Insert the promotion passed in as a parameter.
void	refreshConfigs() Refresh the configuration of the Admin Promotion Manager
void	removeCategoriesFromPromotion(AdminCategory[] categories, int promotionId) Remove an array of categories from the promotion
void	removeCouponsFromPromotion(AdminCoupon[] coupons, int promotionId) Remove an array of coupons from the promotion
void	removeCustomerGroupsFromPromotion(int[] groupIds, int promotionId) Remove an array of groupIds from the promotion
void	removeCustomersFromPromotion(AdminCustomer[] customers, int promotionId) Remove an array of customers from the promotion
void	removeExpressionsFromPromotion(AdminExpression[] expressions, int promotionId) Remove an array of expressions from the promotion
void	removeGiftCertificatesFromPromotion(AdminProduct[] giftCertificates, int promotionId) Remove an array of gift certificates from the promotion.
void	removeManufacturersFromPromotion(AdminManufacturer[] manufacturers, int promotionId) Remove an array of manufacturers from the promotion
void	removeProductsFromPromotion(AdminProduct[] products, int promotionId) Remove an array of products from the promotion.
protected void	removeProductsFromPromotion(AdminProduct[] products, int promotionId, boolean giftCertificate) Remove an array of products from the promotion
void	removePromotionsFromCoupon(AdminPromotion[] promotions, int couponId) Remove an array of promotions from the coupon
protected void	removeTestExpressionFromPromotion(int promotionId) Removes the promotion test expression from the promotion.
protected com.konakart.db.KKCriteria	setAllCouponAttrs(com.konakart.db.KKCriteria c) Set all coupon attributes on the criteria object
protected com.konakart.db.KKCriteria	setAllPromotionAttrs(com.konakart.db.KKCriteria c) Sets all promotion attributes on the criteria object
protected void	validateCoupon(AdminCoupon coupon) Used to validate a coupon before editing or inserting
protected void	validatePromotion(AdminPromotion prom) Used to validate a promotion before editing or inserting

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

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

mutex

protected static java.lang.String mutex

mutex

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

AdminPromotionMgr

public AdminPromotionMgr(KKAdminIf eng)
                  throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getCustomersCountWhoHaventPlacedAnOrderSince

public int getCustomersCountWhoHaventPlacedAnOrderSince(java.util.Calendar lastOrderDate)
                                                 throws KKAdminException,
                                                        org.apache.torque.TorqueException,
                                                        com.workingdogs.village.DataSetException

Return the count of the number of customers who haven't placed an order since the lastOrderDate passed in as a parameter.

Specified by:

getCustomersCountWhoHaventPlacedAnOrderSince in interface AdminPromotionMgrIf

Parameters:

lastOrderDate - the lastOrderDate

Returns:

The customer count

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

getCustomersCountWhoHavePlacedAnOrderSince

public int getCustomersCountWhoHavePlacedAnOrderSince(java.util.Calendar lastOrderDate)
                                               throws KKAdminException,
                                                      org.apache.torque.TorqueException,
                                                      com.workingdogs.village.DataSetException

Return the count of the number of customers who have placed an order since the lastOrderDate passed in as a parameter.

Specified by:

getCustomersCountWhoHavePlacedAnOrderSince in interface AdminPromotionMgrIf

Parameters:

lastOrderDate - the lastOrderDate

Returns:

The customer count

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

addCustomersToPromotion

public void addCustomersToPromotion(java.util.Calendar lastOrderDate,
                                    boolean havePlacedOrder,
                                    int promotionId,
                                    int rule,
                                    int maxUse)
                             throws KKAdminException,
                                    org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException

Add to the promotion identified by promotionId, the customers who have or haven't placed an order since the lastOrderDate passed in as a parameter.

Specified by:

addCustomersToPromotion in interface AdminPromotionMgrIf

Parameters:

lastOrderDate - the lastOrderDate

havePlacedOrder - If true we add customers who have placed an order

promotionId - the promotionId

rule - the rule

maxUse - the maxUse

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

insertPromotion

public int insertPromotion(AdminPromotion prom)
                    throws java.lang.Exception

Description copied from interface: AdminPromotionMgrIf

Insert the promotion passed in as a parameter.

Specified by:

insertPromotion in interface AdminPromotionMgrIf

Parameters:

prom - the prom

Returns:

Returns the id of the inserted promotion

Throws:

java.lang.Exception - an unexpected exception

insertCoupon

public int insertCoupon(AdminCoupon coupon)
                 throws java.lang.Exception

Inserts a coupon

Specified by:

insertCoupon in interface AdminPromotionMgrIf

Parameters:

coupon - the coupon

Returns:

Returns the id of the inserted coupon

Throws:

java.lang.Exception - an unexpected exception

insertCoupon

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

Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion

Specified by:

insertCoupon in interface AdminPromotionMgrIf

Parameters:

coupon - the coupon

promotionId - the promotionId

Returns:

Returns the id of the inserted coupon

Throws:

java.lang.Exception - an unexpected exception

insertCoupon

protected int insertCoupon(AdminCoupon coupon,
                           int promotionId,
                           java.sql.Connection connection)
                    throws java.lang.Exception

Inserts a coupon and also a record in the promotion_to_coupon table to associate the coupon to a promotion

Parameters:

coupon - the coupon

promotionId - the promotionId

connection - Is set to null if the insert isn't part of a bigger transaction

Returns:

Returns the id of the inserted coupon

Throws:

java.lang.Exception - an unexpected exception

deletePromotion

public void deletePromotion(int promotionId)
                     throws java.lang.Exception

Delete the promotion referenced to by promotionId.

Specified by:

deletePromotion in interface AdminPromotionMgrIf

Parameters:

promotionId - the promotionId

Throws:

java.lang.Exception - an unexpected exception

deletePromotionWithOptions

public void deletePromotionWithOptions(int promotionId,
                                       AdminDeletePromotionOptions options)
                                throws java.lang.Exception

Delete the promotion referenced to by promotionId. Options allow you to decide how to process coupons.

Specified by:

deletePromotionWithOptions in interface AdminPromotionMgrIf

Parameters:

promotionId - the promotionId

options - the options

Throws:

java.lang.Exception - an unexpected exception

deletePromotionCommonCode

protected void deletePromotionCommonCode(int promotionId,
                                         com.konakart.db.KKCriteria deleteC,
                                         java.sql.Connection con)
                                  throws java.lang.Exception

Method to avoid code duplication

Parameters:

promotionId - the promotionId

deleteC - the deleteC

con - the con

Throws:

java.lang.Exception - an unexpected exception

deleteCouponsPerPromotion

protected void deleteCouponsPerPromotion(int promotionId)
                                  throws java.lang.Exception

If a coupon belongs to only this promotion it is deleted, otherwise just the entry in the promotion to products table is deleted

Parameters:

promotionId - the promotionId

Throws:

java.lang.Exception - an unexpected exception

deleteCoupon

public void deleteCoupon(int couponId)
                  throws org.apache.torque.TorqueException

The coupon is deleted along with any entries in the promotion to coupon table.

Specified by:

deleteCoupon in interface AdminPromotionMgrIf

Parameters:

couponId - the couponId

Throws:

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

editPromotion

public void editPromotion(AdminPromotion promotion)
                   throws java.lang.Exception

Edits the promotion

Specified by:

editPromotion in interface AdminPromotionMgrIf

Parameters:

promotion - the promotion

Throws:

java.lang.Exception - an unexpected exception

editCoupon

public void editCoupon(AdminCoupon coupon)
                throws java.lang.Exception

Edits the coupon

Specified by:

editCoupon in interface AdminPromotionMgrIf

Parameters:

coupon - the coupon

Throws:

java.lang.Exception - an unexpected exception

getPromotion

public AdminPromotion getPromotion(int id,
                                   boolean includeCoupons,
                                   boolean includeStats)
                            throws java.lang.Exception

Get a promotion object and an array of associated coupon objects

Specified by:

getPromotion in interface AdminPromotionMgrIf

Parameters:

id - the id

includeCoupons - If true we add a coupon array to the promotion if any coupons exist

includeStats - If true we calculate how many manufacturers, products, categories, customers, expressions and coupons are included or excluded from the promotion

Returns:

Returns an AdminPromotion object with an array of coupons if applicable

Throws:

java.lang.Exception - an unexpected exception

getCouponsPerPromotion

public AdminCoupon[] getCouponsPerPromotion(int promotionId)
                                     throws org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Get an array of Admin coupon objects for a promotion

Specified by:

getCouponsPerPromotion in interface AdminPromotionMgrIf

Parameters:

promotionId - the promotionId

Returns:

Returns an array of AdminCoupon objects

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)

getProductsPerPromotion

public AdminProducts getProductsPerPromotion(AdminProductSearch search,
                                             int offset,
                                             int size)
                                      throws java.lang.Exception

Get an array of Admin product objects for a promotion. The AdminProductSearch object must have the promotionId set to a valid promotion.

Specified by:

getProductsPerPromotion in interface AdminPromotionMgrIf

Parameters:

search - the search

offset - the offset

size - the size

Returns:

Returns an AdminProducts objects

Throws:

java.lang.Exception - an unexpected exception

getGiftCertificatesPerPromotion

public AdminProducts getGiftCertificatesPerPromotion(AdminProductSearch search,
                                                     int offset,
                                                     int size)
                                              throws java.lang.Exception

Get an array of Admin product gift certificate objects for a promotion. The AdminProductSearch object must have the promotionId set to a valid promotion.

Specified by:

getGiftCertificatesPerPromotion in interface AdminPromotionMgrIf

Parameters:

search - the search

offset - the offset

size - the size

Returns:

Returns an AdminProducts objects

Throws:

java.lang.Exception - an unexpected exception

getProductsPerPromotion

protected AdminProducts getProductsPerPromotion(AdminProductSearch search,
                                                int offset,
                                                int size,
                                                boolean giftCertificate)
                                         throws java.lang.Exception

Get an array of Admin product objects for a promotion. The AdminProductSearch object must have the promotionId set to a valid promotion.

Parameters:

search - the search

offset - the offset

size - the size

giftCertificate - the giftCertificate

Returns:

Returns an AdminProducts objects

Throws:

java.lang.Exception - an unexpected exception

getProductOptionsPerProductAndPromotion

protected AdminOption[] getProductOptionsPerProductAndPromotion(int promotionId,
                                                                int productId,
                                                                boolean giftCertificate)
                                                         throws java.lang.Exception

We return an array of AminOption objects for every product option and value in the promotion.

Parameters:

promotionId - the promotionId

productId - the productId

giftCertificate - the giftCertificate

Returns:

An array of AdminOption objects

Throws:

java.lang.Exception - an unexpected Exception exception

getPromotionsPerCoupon

public AdminPromotion[] getPromotionsPerCoupon(int couponId)
                                        throws java.lang.Exception

Get an array of Admin promotion objects for a coupon

Specified by:

getPromotionsPerCoupon in interface AdminPromotionMgrIf

Parameters:

couponId - the couponId

Returns:

Returns an array of AdminPromotion objects

Throws:

java.lang.Exception - an unexpected exception

getPromotions

public AdminPromotionSearchResult getPromotions(AdminPromotionSearch search,
                                                int offset,
                                                int size)
                                         throws java.lang.Exception

This returns an AdminPromotionSearchResult object.

Specified by:

getPromotions in interface AdminPromotionMgrIf

Parameters:

search - the search

offset - the offset

size - the size

Returns:

Returns an AdminPromotionSearchResult object

Throws:

java.lang.Exception - an unexpected exception

getCoupons

public AdminCouponSearchResult getCoupons(AdminCouponSearch search,
                                          int offset,
                                          int size)
                                   throws org.apache.torque.TorqueException,
                                          com.workingdogs.village.DataSetException

This returns an AdminCouponSearchResult object.

Specified by:

getCoupons in interface AdminPromotionMgrIf

Parameters:

search - the search

offset - the offset

size - the size

Returns:

Returns an AdminCouponSearchResult object

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)

addCustomersToPromotion

public void addCustomersToPromotion(AdminCustomer[] customers,
                                    int promotionId,
                                    int rule,
                                    int maxUse)
                             throws org.apache.torque.TorqueException

Add the array of customers to the promotion

Specified by:

addCustomersToPromotion in interface AdminPromotionMgrIf

Parameters:

customers - the customers

promotionId - the promotionId

rule - the rule

maxUse - -1 for unlimited use

Throws:

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

addCustomerGroupsToPromotion

public void addCustomerGroupsToPromotion(int[] groupIds,
                                         int promotionId,
                                         int rule)
                                  throws java.lang.Exception

Add customers to the promotion belonging to the groups in the array of group ids.

Specified by:

addCustomerGroupsToPromotion in interface AdminPromotionMgrIf

Parameters:

groupIds - the groupIds

promotionId - the promotionId

rule - the rule

Throws:

java.lang.Exception - an unexpected exception

addManufacturersToPromotion

public void addManufacturersToPromotion(AdminManufacturer[] manufacturers,
                                        int promotionId,
                                        int rule)
                                 throws org.apache.torque.TorqueException,
                                        KKAdminException

Add the array of manufacturers to the promotion

Specified by:

addManufacturersToPromotion in interface AdminPromotionMgrIf

Parameters:

manufacturers - the manufacturers

promotionId - the promotionId

rule - the rule

Throws:

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

KKAdminException - unexpected exception in the KonaKart Admin Engine

addExpressionsToPromotion

public void addExpressionsToPromotion(AdminExpression[] expressions,
                                      int promotionId)
                               throws org.apache.torque.TorqueException,
                                      KKAdminException

Add the array of expressions to the promotion

Specified by:

addExpressionsToPromotion in interface AdminPromotionMgrIf

Parameters:

expressions - the expressions

promotionId - the promotionId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

addCategoriesToPromotion

public void addCategoriesToPromotion(AdminCategory[] categories,
                                     int promotionId,
                                     int rule)
                              throws org.apache.torque.TorqueException

Add the array of categories to the promotion

Specified by:

addCategoriesToPromotion in interface AdminPromotionMgrIf

Parameters:

categories - the categories

promotionId - the promotionId

rule - the rule

Throws:

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

addProductsToPromotion

public void addProductsToPromotion(AdminProduct[] products,
                                   int promotionId,
                                   int rule)
                            throws org.apache.torque.TorqueException,
                                   KKAdminException

Add the array of products to the promotion. Each product may have an array of options. When this array exists, we only add those particular options to the promotion. Otherwise we set the option and option value ids to -1.

Specified by:

addProductsToPromotion in interface AdminPromotionMgrIf

Parameters:

products - the products

promotionId - the promotionId

rule - the rule

Throws:

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

KKAdminException - unexpected exception in the KonaKart Admin Engine

addGiftCertificatesToPromotion

public void addGiftCertificatesToPromotion(AdminProduct[] giftCertificates,
                                           int promotionId)
                                    throws org.apache.torque.TorqueException,
                                           KKAdminException

Associates the gift certificate products with the promotion. The products may have an array of options. When this array exists, we only add those particular options to the promotion. Otherwise we set the option and option value ids to -1.

Specified by:

addGiftCertificatesToPromotion in interface AdminPromotionMgrIf

Parameters:

giftCertificates - the giftCertificates

promotionId - the promotionId

Throws:

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

KKAdminException - unexpected exception in the KonaKart Admin Engine

addProductsToPromotion

protected void addProductsToPromotion(AdminProduct[] products,
                                      int promotionId,
                                      int rule,
                                      boolean giftCertificate)
                               throws org.apache.torque.TorqueException,
                                      KKAdminException

Add the array of products to the promotion. Each product may have an array of options. When this array exists, we only add those particular options to the promotion. Otherwise we set the option and option value ids to -1.

Parameters:

products - the products

promotionId - the promotionId

rule - the rule

giftCertificate - the giftCertificate

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin Engine

removeCustomersFromPromotion

public void removeCustomersFromPromotion(AdminCustomer[] customers,
                                         int promotionId)
                                  throws org.apache.torque.TorqueException

Remove an array of customers from the promotion

Specified by:

removeCustomersFromPromotion in interface AdminPromotionMgrIf

Parameters:

customers - the customers

promotionId - the promotionId

Throws:

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

removeManufacturersFromPromotion

public void removeManufacturersFromPromotion(AdminManufacturer[] manufacturers,
                                             int promotionId)
                                      throws org.apache.torque.TorqueException

Remove an array of manufacturers from the promotion

Specified by:

removeManufacturersFromPromotion in interface AdminPromotionMgrIf

Parameters:

manufacturers - the manufacturers

promotionId - the promotionId

Throws:

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

removeExpressionsFromPromotion

public void removeExpressionsFromPromotion(AdminExpression[] expressions,
                                           int promotionId)
                                    throws org.apache.torque.TorqueException,
                                           KKAdminException

Remove an array of expressions from the promotion

Specified by:

removeExpressionsFromPromotion in interface AdminPromotionMgrIf

Parameters:

expressions - the expressions

promotionId - the promotionId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin Engine

removeCategoriesFromPromotion

public void removeCategoriesFromPromotion(AdminCategory[] categories,
                                          int promotionId)
                                   throws org.apache.torque.TorqueException

Remove an array of categories from the promotion

Specified by:

removeCategoriesFromPromotion in interface AdminPromotionMgrIf

Parameters:

categories - the categories

promotionId - the promotionId

Throws:

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

removeCustomerGroupsFromPromotion

public void removeCustomerGroupsFromPromotion(int[] groupIds,
                                              int promotionId)
                                       throws org.apache.torque.TorqueException

Remove an array of groupIds from the promotion

Specified by:

removeCustomerGroupsFromPromotion in interface AdminPromotionMgrIf

Parameters:

groupIds - the groupIds

promotionId - the promotionId

Throws:

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

removeProductsFromPromotion

public void removeProductsFromPromotion(AdminProduct[] products,
                                        int promotionId)
                                 throws org.apache.torque.TorqueException

Remove an array of products from the promotion. All promotions ar eremoved if the array is set to null.

Specified by:

removeProductsFromPromotion in interface AdminPromotionMgrIf

Parameters:

products - the products

promotionId - the promotionId

Throws:

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

removeGiftCertificatesFromPromotion

public void removeGiftCertificatesFromPromotion(AdminProduct[] giftCertificates,
                                                int promotionId)
                                         throws org.apache.torque.TorqueException

Remove an array of gift certificates from the promotion. All gift certificates are removed if the array is set to null.

Specified by:

removeGiftCertificatesFromPromotion in interface AdminPromotionMgrIf

Parameters:

giftCertificates - the giftCertificates

promotionId - the promotionId

Throws:

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

removeProductsFromPromotion

protected void removeProductsFromPromotion(AdminProduct[] products,
                                           int promotionId,
                                           boolean giftCertificate)
                                    throws org.apache.torque.TorqueException

Remove an array of products from the promotion

Parameters:

products - the products

promotionId - the promotionId

giftCertificate - the giftCertificate

Throws:

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

removeCouponsFromPromotion

public void removeCouponsFromPromotion(AdminCoupon[] coupons,
                                       int promotionId)
                                throws org.apache.torque.TorqueException

Remove an array of coupons from the promotion

Specified by:

removeCouponsFromPromotion in interface AdminPromotionMgrIf

Parameters:

coupons - the coupons

promotionId - the promotionId

Throws:

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

removePromotionsFromCoupon

public void removePromotionsFromCoupon(AdminPromotion[] promotions,
                                       int couponId)
                                throws org.apache.torque.TorqueException

Remove an array of promotions from the coupon

Specified by:

removePromotionsFromCoupon in interface AdminPromotionMgrIf

Parameters:

promotions - the promotions

couponId - the couponId

Throws:

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

addCouponsToPromotion

public void addCouponsToPromotion(AdminCoupon[] coupons,
                                  int promotionId)
                           throws org.apache.torque.TorqueException

Add the array of coupons to the promotion. We assume that the coupon has already been inserted.

Specified by:

addCouponsToPromotion in interface AdminPromotionMgrIf

Parameters:

coupons - the coupons

promotionId - the promotionId

Throws:

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

addPromotionsToCoupon

public void addPromotionsToCoupon(AdminPromotion[] promotions,
                                  int couponId)
                           throws org.apache.torque.TorqueException

Add the array of promotions to the coupon.

Specified by:

addPromotionsToCoupon in interface AdminPromotionMgrIf

Parameters:

promotions - the promotions

couponId - the couponId

Throws:

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

getPromotionsCount

public int getPromotionsCount(AdminPromotionSearch search)
                       throws java.lang.Exception

Returns a count of the number of Promotions

Specified by:

getPromotionsCount in interface AdminPromotionMgrIf

Parameters:

search - Search criteria

Returns:

A count of the number of Promotions

Throws:

java.lang.Exception - an unexpected exception

getCouponsCount

public int getCouponsCount(AdminCouponSearch search)
                    throws org.apache.torque.TorqueException,
                           com.workingdogs.village.DataSetException

Returns a count of the number of Coupons

Specified by:

getCouponsCount in interface AdminPromotionMgrIf

Parameters:

search - Search criteria

Returns:

A count of the number of Coupons

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)

getCount

protected int getCount(com.konakart.db.KKCriteria c)
                throws org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the Criteria

Returns:

The number of records present in the database matching the given criteria

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)

addPromotionOrderBy

protected void addPromotionOrderBy(com.konakart.db.KKCriteria c,
                                   AdminPromotionSearch search)

Add order by constraints to query

Parameters:

c - the c

search - the search

addCouponOrderBy

protected void addCouponOrderBy(com.konakart.db.KKCriteria c,
                                AdminCouponSearch search)

Add order by constraints to query

Parameters:

c - the c

search - the search

addPromotionSearchCriteria

protected int addPromotionSearchCriteria(com.konakart.db.KKCriteria c,
                                         AdminPromotionSearch promSearch)
                                  throws java.lang.Exception

Add search criteria to query

Parameters:

c - the c

promSearch - the promSearch

Returns:

Returns number of constraints added

Throws:

java.lang.Exception - an unexpected exception

addCouponSearchCriteria

protected int addCouponSearchCriteria(com.konakart.db.KKCriteria c,
                                      AdminCouponSearch couponSearch)

Add search criteria to query

Parameters:

c - the c

couponSearch - the couponSearch

Returns:

Returns number of constraints added

validatePromotion

protected void validatePromotion(AdminPromotion prom)
                          throws KKAdminException

Used to validate a promotion before editing or inserting

Parameters:

prom - the prom

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

validateCoupon

protected void validateCoupon(AdminCoupon coupon)
                       throws KKAdminException

Used to validate a coupon before editing or inserting

Parameters:

coupon - the coupon

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

setAllPromotionAttrs

protected com.konakart.db.KKCriteria setAllPromotionAttrs(com.konakart.db.KKCriteria c)
                                                   throws org.apache.torque.TorqueException,
                                                          com.workingdogs.village.DataSetException,
                                                          java.lang.Exception

Sets all promotion attributes on the criteria object

Parameters:

c - the c

Returns:

Returns the criteria object

Throws:

java.lang.Exception - an unexpected exception

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)

setAllCouponAttrs

protected com.konakart.db.KKCriteria setAllCouponAttrs(com.konakart.db.KKCriteria c)

Set all coupon attributes on the criteria object

Parameters:

c - the c

Returns:

Returns the Criteria object

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Promotion Manager

Specified by:

refreshConfigs in interface AdminPromotionMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

getPromotionIdForGiftCertificate

public int getPromotionIdForGiftCertificate(AdminOrderProduct op)
                                     throws KKAdminException,
                                            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 AdminPromotionMgrIf

Parameters:

op - the op

Returns:

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

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

addTestExpressionToPromotion

protected void addTestExpressionToPromotion(int promotionId)
                                     throws KKAdminException,
                                            org.apache.torque.TorqueException,
                                            com.workingdogs.village.DataSetException

Adds the promotion test expression to the promotion. An exception is thrown if the expression cannot be found.

Parameters:

promotionId - the promotionId

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

removeTestExpressionFromPromotion

protected void removeTestExpressionFromPromotion(int promotionId)
                                          throws KKAdminException,
                                                 org.apache.torque.TorqueException,
                                                 com.workingdogs.village.DataSetException

Removes the promotion test expression from the promotion. If the expression cannot be found, a warning is written to the log.

Parameters:

promotionId - the promotionId

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

getTestExpressionId

protected int getTestExpressionId()
                           throws KKAdminException,
                                  org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException

Returns:

Returns the id of the Promotion Test Expression. An exception is thrown if it doesn't exist.

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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)

getStoreTime

public java.util.Calendar getStoreTime()
                                throws java.lang.Exception

Returns the local store time based on the tz database time zone of the store. A list can be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones . They are in a string format and look like US/Pacific, Australia/Perth, Europe/London etc. and observe DST.

Specified by:

getStoreTime in interface AdminPromotionMgrIf

Returns:

Returns a Calendar object for the current store time

Throws:

java.lang.Exception - an unexpected exception