com.konakartadmin.bl

Class AdminAddressMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminAddressMgr

All Implemented Interfaces:

AdminAddressMgrIf

public class AdminAddressMgr
extends AdminBaseMgr
implements AdminAddressMgrIf

The AdminAddressMgr - for Managing Address 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
protected static org.apache.commons.logging.Log	log the log

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

Method Summary

Modifier and Type	Method and Description
void	addAddressesToProduct(AdminAddress[] addresses, int productId) Associate an array of addresses to a product.
protected void	addAddressFormatOrderBy(com.konakart.db.KKCriteria c, AdminAddressFormatSearch search) addAddressFormatOrderBy
protected int	addAddressFormatSearchCriteria(com.konakart.db.KKCriteria c, AdminAddressFormatSearch search) addAddressFormatSearchCriteria
protected void	addAddressOrderBy(com.konakart.db.KKCriteria c, AdminAddressSearch search) addAddressOrderBy
protected void	addAddressSearchCriteria(com.konakart.db.KKCriteria c, AdminAddressSearch search) addAddressSearchCriteria
void	deleteAddress(int addressId) Deletes an AdminAddress.
int	deleteAddressFormat(int id) Delete an AddressFormat
boolean	doesAddressExistForId(int addrId) Checks to see whether an address already exists with this id
boolean	doesAddressFormatExist(int addressFormatId) Return true if the AddressFormat exists.
AdminAddress	getAddressById(int addressId) Get Addresses defined by the search criteria
AdminAddressSearchResult	getAddresses(AdminAddressSearch search, int offset, int size) Get Addresses defined by the search criteria
AdminAddressFormatSearchResult	getAddressFormats(AdminAddressFormatSearch search) This returns an AdminAddressFormatSearchResult object.
private 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.
int	getProductCountPerAddress(int addressId) Returns the number of products using the address
int	insertAddress(AdminAddress address) Insert an AdminAddress. KonaKart supports addresses for customers, products, manufacturers and stores.
int	insertAddressFormat(AdminAddressFormat addressFormat) Insert an AdminAddressFormat object
void	refreshConfigs() Refresh the configuration of the Admin Currency Manager
void	removeAddressFromProduct(int addressId, int productId) Remove the relationship between the address and the product.
void	setAddressCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Common code to avoid duplication
protected void	setAddressInsertCriteriaWithStandardAttributes(com.konakart.db.KKCriteria insertC, AdminAddress address) Common code to avoid duplication
void	updateAddress(AdminAddress address) Updates an AdminAddress.
int	updateAddressFormat(AdminAddressFormat addressFormat) Update an AdminAddressFormat object

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

Constructor Detail

AdminAddressMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getAddressFormats

public AdminAddressFormatSearchResult getAddressFormats(AdminAddressFormatSearch search)
                                                 throws KKAdminException

This returns an AdminAddressFormatSearchResult object.

Specified by:

getAddressFormats in interface AdminAddressMgrIf

Parameters:

search - the search

Returns:

Returns an AdminAddressFormatSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteAddressFormat

public int deleteAddressFormat(int id)
                        throws KKAdminException

Delete an AddressFormat

Specified by:

deleteAddressFormat in interface AdminAddressMgrIf

Parameters:

id - An AddressFormat id

Returns:

returns the id of the deleted AddressFormat

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertAddressFormat

public int insertAddressFormat(AdminAddressFormat addressFormat)
                        throws KKAdminException

Insert an AdminAddressFormat object

Specified by:

insertAddressFormat in interface AdminAddressMgrIf

Parameters:

addressFormat - An AdminAddressFormat object

Returns:

returns the id of the inserted AdminAddressFormat object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateAddressFormat

public int updateAddressFormat(AdminAddressFormat addressFormat)
                        throws KKAdminException

Update an AdminAddressFormat object

Specified by:

updateAddressFormat in interface AdminAddressMgrIf

Parameters:

addressFormat - An AdminAddressFormat object

Returns:

returns the id of the updated AdminAddressFormat object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addAddressFormatOrderBy

protected void addAddressFormatOrderBy(com.konakart.db.KKCriteria c,
                                       AdminAddressFormatSearch search)

addAddressFormatOrderBy

Parameters:

c - the c

search - the search

addAddressFormatSearchCriteria

protected int addAddressFormatSearchCriteria(com.konakart.db.KKCriteria c,
                                             AdminAddressFormatSearch search)

addAddressFormatSearchCriteria

Parameters:

c - the c

search - the search

Returns:

Returns the number of constraints added

doesAddressFormatExist

public boolean doesAddressFormatExist(int addressFormatId)
                               throws org.apache.torque.TorqueException,
                                      KKAdminException

Return true if the AddressFormat exists.

Specified by:

doesAddressFormatExist in interface AdminAddressMgrIf

Parameters:

addressFormatId - the addressFormatId

Returns:

True if the category exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Currency Manager

Specified by:

refreshConfigs in interface AdminAddressMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

doesAddressExistForId

public boolean doesAddressExistForId(int addrId)
                              throws org.apache.torque.TorqueException,
                                     KKAdminException

Checks to see whether an address already exists with this id

Specified by:

doesAddressExistForId in interface AdminAddressMgrIf

Parameters:

addrId - the addrId

Returns:

Returns true if the address already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAddressById

public AdminAddress getAddressById(int addressId)
                            throws KKAdminException,
                                   org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException

Description copied from interface: AdminAddressMgrIf

Get Addresses defined by the search criteria

Specified by:

getAddressById in interface AdminAddressMgrIf

Parameters:

addressId - the id of the address to retrieve

Returns:

the Address with the specified Id if it exists, otherwise null.

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)

getAddresses

public AdminAddressSearchResult getAddresses(AdminAddressSearch search,
                                             int offset,
                                             int size)
                                      throws KKAdminException,
                                             org.apache.torque.TorqueException,
                                             com.workingdogs.village.DataSetException

Description copied from interface: AdminAddressMgrIf

Get Addresses defined by the search criteria

Specified by:

getAddresses in interface AdminAddressMgrIf

Parameters:

search - the search criteria

offset - the offset in the record set to start from

size - the maximum number of records to return

Returns:

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

addAddressSearchCriteria

protected void addAddressSearchCriteria(com.konakart.db.KKCriteria c,
                                        AdminAddressSearch search)
                                 throws KKAdminException

addAddressSearchCriteria

Parameters:

c - the c

search - the search

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addAddressOrderBy

protected void addAddressOrderBy(com.konakart.db.KKCriteria c,
                                 AdminAddressSearch search)

addAddressOrderBy

Parameters:

c - the c

search - the search

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)

getCount

private 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

setAddressCriteriaWithStandardAttributes

public void setAddressCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c)

Common code to avoid duplication

Specified by:

setAddressCriteriaWithStandardAttributes in interface AdminAddressMgrIf

Parameters:

c - the c

setAddressInsertCriteriaWithStandardAttributes

protected void setAddressInsertCriteriaWithStandardAttributes(com.konakart.db.KKCriteria insertC,
                                                              AdminAddress address)
                                                       throws org.apache.torque.TorqueException,
                                                              com.workingdogs.village.DataSetException,
                                                              KKAdminException,
                                                              java.lang.Exception

Common code to avoid duplication

Parameters:

insertC - the insertC

address - the address

Throws:

java.lang.Exception - an unexpected exception

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

deleteAddress

public void deleteAddress(int addressId)
                   throws KKAdminException

Description copied from interface: AdminAddressMgrIf

Deletes an AdminAddress.

Specified by:

deleteAddress in interface AdminAddressMgrIf

Parameters:

addressId - the id of the address to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertAddress

public int insertAddress(AdminAddress address)
                  throws java.lang.Exception

Description copied from interface: AdminAddressMgrIf

Insert an AdminAddress.
KonaKart supports addresses for customers, products, manufacturers and stores. The following rules apply:

• If customerId > 0 the address is assumed to be that of a customer
• If manufacturerId > 0 the address is assumed to be that of a manufacturer
• If addrStoreId != null the address is assumed to be that of a store
• Otherwise we assume that the address may be used for a product. Many products may be associated to the same address (e.g. dropshipper address) so the product addresses are linked to products indirectly using a seperate DB table.

Specified by:

insertAddress in interface AdminAddressMgrIf

Parameters:

address - an AdminAddress object

Returns:

Returns the addresId of the newly-inserted AdminAddress

Throws:

java.lang.Exception - an unexpected exception

updateAddress

public void updateAddress(AdminAddress address)
                   throws KKAdminException

Description copied from interface: AdminAddressMgrIf

Updates an AdminAddress.

Specified by:

updateAddress in interface AdminAddressMgrIf

Parameters:

address - the AdminAddress object to update

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addAddressesToProduct

public void addAddressesToProduct(AdminAddress[] addresses,
                                  int productId)
                           throws KKAdminException,
                                  org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException

Associate an array of addresses to a product.

Specified by:

addAddressesToProduct in interface AdminAddressMgrIf

Parameters:

addresses - the addresses

productId - the productId

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)

removeAddressFromProduct

public void removeAddressFromProduct(int addressId,
                                     int productId)
                              throws KKAdminException,
                                     org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException

Remove the relationship between the address and the product.

Specified by:

removeAddressFromProduct in interface AdminAddressMgrIf

Parameters:

addressId - the addressId

productId - the productId

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)

getProductCountPerAddress

public int getProductCountPerAddress(int addressId)
                              throws com.workingdogs.village.DataSetException,
                                     KKAdminException,
                                     org.apache.torque.TorqueException

Returns the number of products using the address

Specified by:

getProductCountPerAddress in interface AdminAddressMgrIf

Parameters:

addressId - the addressId

Returns:

Return the number of products using the address

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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