com.konakartadmin.bl

Class AdminWishListMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminWishListMgr

All Implemented Interfaces:

AdminWishListMgrIf

public class AdminWishListMgr
extends AdminBaseMgr
implements AdminWishListMgrIf

The AdminWishListMgr - for Managing Wish List Objects for the Admin Application

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
static int	BIRTHDAY_LIST_TYPE Defines the type of wish list
protected static org.apache.commons.logging.Log	log the log
static int	WEDDING_LIST_TYPE Defines the type of wish list
static int	WISH_LIST_TYPE Defines the type of wish list

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
AdminWishListMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addWishListOrderBy(com.konakart.db.KKCriteria c, AdminWishListSearch search)
protected void	addWishListSearchCriteria(com.konakart.db.KKCriteria c, AdminWishListSearch search)
void	deleteWishList(int wishListId) Delete a wishlist and all of its wishlist items.
void	deleteWishListItem(int wishListItemId) Delete a wishlist and all of its wishlist items.
protected int	getCount(com.konakart.db.KKCriteria c, org.apache.torque.map.ColumnMap colMap)
protected int	getCount(com.konakart.db.KKCriteria c, java.lang.String key) This method is mainly used for paging.
protected AdminWishListItem[]	getWishListItemsByWishListId(int wishListId)
AdminWishLists	getWishLists(AdminWishListSearch search, int offset, int size) Return the WishList objects defined by the search criteria.
int	insertWishList(AdminWishList wishList) Insert a wishlist and any attached wishlist items.
int	insertWishListItem(AdminWishListItem wishListItem) Insert an AdminWishListItem.
private int	insertWishListItem(AdminWishListItem wishListItem, java.sql.Connection con)
protected void	setWishListCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Common code to avoid duplication
protected void	setWishListItemCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Common code to avoid duplication
void	updateWishListItemQuantityBought(int wishListItemId, int quantityBought) Updates the wishListItem quantity received attribute by adding quantityBought to the actual value.

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, refreshConfigs, 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

WISH_LIST_TYPE

public static final int WISH_LIST_TYPE

Defines the type of wish list

See Also:

Constant Field Values

WEDDING_LIST_TYPE

public static final int WEDDING_LIST_TYPE

Defines the type of wish list

See Also:

Constant Field Values

BIRTHDAY_LIST_TYPE

public static final int BIRTHDAY_LIST_TYPE

Defines the type of wish list

See Also:

Constant Field Values

Constructor Detail

AdminWishListMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

updateWishListItemQuantityBought

public void updateWishListItemQuantityBought(int wishListItemId,
                                             int quantityBought)
                                      throws org.apache.torque.TorqueException,
                                             com.workingdogs.village.DataSetException

Updates the wishListItem quantity received attribute by adding quantityBought to the actual value.

Specified by:

updateWishListItemQuantityBought in interface AdminWishListMgrIf

Parameters:

wishListItemId - the wishListItemId

quantityBought - the quantityBought

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)

insertWishList

public int insertWishList(AdminWishList wishList)
                   throws KKAdminException

Description copied from interface: AdminWishListMgrIf

Insert a wishlist and any attached wishlist items. This method is intended to be used for importing wishlists that have previously been validated and saved maybe in another KonaKart. It is used by the KonaKart XML import / export functionality.

Specified by:

insertWishList in interface AdminWishListMgrIf

Parameters:

wishList - the wishList

Returns:

Returns the wishlist Id of the newly-inserted wishlist

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteWishList

public void deleteWishList(int wishListId)
                    throws KKAdminException

Description copied from interface: AdminWishListMgrIf

Delete a wishlist and all of its wishlist items.

Specified by:

deleteWishList in interface AdminWishListMgrIf

Parameters:

wishListId - the wishListId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertWishListItem

public int insertWishListItem(AdminWishListItem wishListItem)
                       throws KKAdminException

Description copied from interface: AdminWishListMgrIf

Insert an AdminWishListItem. This method is intended to be used for importing wishlists that have previously been validated and saved maybe in another KonaKart. It is used by the KonaKart XML import / export functionality.

Specified by:

insertWishListItem in interface AdminWishListMgrIf

Parameters:

wishListItem - the wishListItem

Returns:

Returns the wishListItem Id of the newly-inserted AdminWishListItem

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertWishListItem

private int insertWishListItem(AdminWishListItem wishListItem,
                               java.sql.Connection con)
                        throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

deleteWishListItem

public void deleteWishListItem(int wishListItemId)
                        throws KKAdminException

Description copied from interface: AdminWishListMgrIf

Delete a wishlist and all of its wishlist items.

Specified by:

deleteWishListItem in interface AdminWishListMgrIf

Parameters:

wishListItemId - the wishListItemId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getWishLists

public AdminWishLists getWishLists(AdminWishListSearch search,
                                   int offset,
                                   int size)
                            throws java.lang.Exception

Description copied from interface: AdminWishListMgrIf

Return the WishList objects defined by the search criteria. If the includeChildren attribute on the AdminWishListSearch is true the WishListItem children on each WishList object are returned.

Specified by:

getWishLists in interface AdminWishListMgrIf

Parameters:

search - the AdminWishListSearch object that defines the wishlist objects to search for. If null we use the default AdminWishListSearch object.

offset - starting offset in database - so that you can page through results

size - size of the group that will be returned - the maximum number of records returned

Returns:

an AdminWishLists object

Throws:

KKAdminException - an 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)

java.lang.Exception - an unexpected exception

getWishListItemsByWishListId

protected AdminWishListItem[] getWishListItemsByWishListId(int wishListId)
                                                    throws org.apache.torque.TorqueException,
                                                           com.workingdogs.village.DataSetException

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

addWishListSearchCriteria

protected void addWishListSearchCriteria(com.konakart.db.KKCriteria c,
                                         AdminWishListSearch search)

addWishListOrderBy

protected void addWishListOrderBy(com.konakart.db.KKCriteria c,
                                  AdminWishListSearch search)

getCount

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

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

getCount

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

This method is mainly used for paging.

Parameters:

c - the c

key - we have to use a key instead of just a * when there are no search 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)

setWishListCriteriaWithStandardAttributes

protected void setWishListCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)

Common code to avoid duplication

Parameters:

c - the c

setWishListItemCriteriaWithStandardAttributes

protected void setWishListItemCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)

Common code to avoid duplication

Parameters:

c - the c