com.konakartadmin.bl

Class AdminCustomerMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminCustomerMgr

All Implemented Interfaces:

AdminCustomerMgrIf

Direct Known Subclasses:

AdminCustomerMgrEE

public class AdminCustomerMgr
extends AdminBaseMgr
implements AdminCustomerMgrIf

The AdminCustomerMgr - for Managing Customer 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 java.lang.String	availableChars Characters used for generating customer passwords - can be set in konakartadmin.properties
protected static java.lang.String	availableLowerChars Used for password generation
protected static java.lang.String	availableNumericChars Used for password generation
protected static java.lang.String	availableSpecialChars Used for password generation
protected static java.lang.String	availableUpperChars Used for password generation
protected static boolean	DEFAULT_DELETE_REVIEWS default is to delete reviews
protected static java.lang.String	DEFAULT_PASSWORD_CHARACTERS Used for customer password generation
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
AdminCustomerMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	addChildrenToCustomer(int parentId, AdminCustomer[] children) The array of AdminCustomer children objects are given the parent id passed in as a parameter.
protected void	addCustomerGroupOrderBy(com.konakart.db.KKCriteria c, AdminCustomerGroupSearch search) Add CustomerGroup OrderBy
protected int	addCustomerGroupSearchCriteria(com.konakart.db.KKCriteria c, AdminCustomerGroupSearch search)
protected void	addCustomerOrderBy(com.konakart.db.KKCriteria c, AdminCustomerSearch custSearch) Add Customer OrderBy
protected int	addCustomerSearchCriteria(com.konakart.db.KKCriteria c, AdminCustomerSearch custSearch, boolean addressJoin) Adds search criteria to the query depending on what is in the custSearch object
void	addVendorToStore(int vendorId, java.lang.String vendorStoreId) Associates a vendor with a store
void	checkUniquenessForRegistration(AdminCustomerRegistration custReg, boolean force) Check uniqueness for the username, telephone and telephone1
void	checkUniquenessForUpdate(AdminUpdateCustomerOptions options, AdminCustomer currentCust, AdminCustomer cust) Check uniqueness for the username, telephone and telephone1
AdminCloneCustomerResult	cloneCustomer(int superUserId, int cloneCustId, java.lang.String[] stores) This API call is used to clone customers across multiple stores and is only available when in multi-store single DB, non shared customer mode.
void	createMailingList(AdminCustomerSearch search, AdminMailListOptions listOptions) Create a mailing list file on disk that contains a record for every customer defined by the AdminCustomerSearch object.
int	deleteCustomer(int custId) Deletes a customer from the database.
int	deleteCustomerGroup(int custGroupId) Delete a Customer Group.
AdminDeleteCustomerResult	deleteCustomerMultiStore(int superUserId, int customerId, java.lang.String[] stores) This API call is used to delete customers across multiple stores and is only available when in multi-store single DB, non shared customer mode.
protected void	deleteCustomerReviews(int custId, java.sql.Connection con) Deletes a customer's reviews from the database.
void	deleteProductNotification(int custId, int prodId) Delete a Product Notification record for the specified customer and product if it's found.
protected boolean	deleteReviews() Utility method to return the konakart.delete_reviews property value
void	deleteVendor(int vendorId) Delete a vendor
protected boolean	doesCountryExist(int countryId)
boolean	doesCustomerExistForEmail(java.lang.String emailAddr) Checks to see whether a registered customer already exists with this email address.
boolean	doesCustomerExistForId(int custId) Checks to see whether a customer already exists with this id
boolean	doesCustomerExistForTelephone(java.lang.String telephone) Checks to see whether a registered customer already exists with this telephone number.
boolean	doesCustomerExistForTelephone1(java.lang.String telephone1) Checks to see whether a registered customer already exists with this telephone 1 number.
boolean	doesCustomerExistForUsername(java.lang.String username) Checks to see whether a registered customer already exists with this username.
protected boolean	doesZoneExist(java.lang.String zoneDesc, int countryId) If a country has at least one zone defined in the database, then we assume that all zones are defined and ensure that we only allow zones that are defined in the database.
int	forceRegisterCustomer(AdminCustomerRegistration custReg) Calls RegisterCustomerPrivate() with force set to true
java.lang.String	getAddressFormatTemplate(int id) Does a query on the address_format table
AdminAddressFormat[]	getAllAddressFormats() This returns an array of all the address formats
java.lang.String	getAvailableChars()
protected int	getCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
AdminCustomer	getCustomerForEmail(java.lang.String emailAddr) Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.
AdminCustomer	getCustomerForEmailWithOptions(java.lang.String emailAddr, AdminGetCustomerOptions options) Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.
AdminCustomer	getCustomerForId(int customerId) Returns the customer object for the customer defined by the given id.
AdminCustomer	getCustomerForIdWithOptions(int customerId, AdminGetCustomerOptions options) Returns the customer object for the customer defined by the given id.
AdminCustomerGroupSearchResult	getCustomerGroups(AdminCustomerGroupSearch search) This returns an AdminCustomerGroupSearchResult object.
AdminCustomerGroup[]	getCustomerGroupsPerPromotion(int promotionId, int languageId) Returns all of the customer groups for the promotion
int	getCustomerIdForEmail(java.lang.String emailAddr) Finds the custId of the specified customer.
AdminCustomerSearchResult	getCustomers(AdminCustomerSearch custSearch, int offset, int size) Returns a set of Customers that match the search criteria
int	getCustomersCount(AdminCustomerSearch search) Returns a count of the number of Customers
AdminCustomerSearchResult	getCustomersLite(AdminCustomerSearch custSearch, int offset, int size) Returns a set of "Lite" Customers that match the search criteria.
java.lang.String	getDbPassword(int userId) Get the password from the database for the given userId
AdminProductNotification[]	getProductNotificationsForCustomer(int customerId) Get an array of product notifications for the customer
java.lang.String	getRandomPassword(int length) If length == 0, the configuration value ENTRY_PASSWORD_MIN_LENGTH is used.
AdminStore[]	getStoresForCustomer(int superUserId, java.lang.String emailAddress) This API call is only available when in multi-store single DB, non shared customer mode.
protected java.lang.String	getTagValue(java.lang.String value, int rule, java.lang.String preWildCard, java.lang.String postWildCard) Utility method to return the formatted tag value
AdminVendor	getVendorForId(int vendorId) Return a vendor for the numeric vendorId
AdminVendorSearchResult	getVendors(AdminVendorSearch vendorSearch, int offset, int size) Returns a set of Vendors that match the search criteria
void	incrementLogonCount(int customerId) This method increments the logon count attribute of the customers_info table and sets the last logged in date for the customer..
int	insertCustomerGroup(AdminCustomerGroup custGroup) Insert a customer group
int	insertCustomerGroups(AdminCustomerGroup[] custGroups) Insert an array of AdminCustomerGroup objects.
void	insertProductNotification(int custId, int prodId) Insert a Product Notification record for the specified customer and product.
int	insertVendor(AdminVendor vendor) Insert a vendor
void	populateCustomerChildren(AdminCustomer[] parents, boolean recursive) Populates the child customers of the array of parent customers passed in as a parameter.
void	populateCustomerParents(AdminCustomer[] customers) Populates the parent customer of the customers passed in as a parameter
void	refreshConfigs() Refresh the configuration of the Manager
int	registerCustomer(AdminCustomerRegistration custReg) Calls RegisterCustomerPrivate() with force set to false
int	registerCustomerPrivate(AdminCustomerRegistration custReg, boolean force) A new customer is added to the system.
void	resetCustomerPassword(int custId) Reset a customer's password.
protected void	resetCustomerPassword(int custId, java.lang.String eMailAddr) Reset a customer's password.
void	resetCustomerPasswordSpecifyingEmail(int custId, java.lang.String eMailAddress) Reset a customer's password using the eMail address specified.
void	sendTemplateEmailToCustomers(AdminCustomerSearch custSearch, java.lang.String templateName, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3, java.lang.Object obj4, java.lang.Object obj5, int numberEmailThreads) Calls sendTemplateEmailToCustomersWithOptions() with null options.
void	sendTemplateEmailToCustomersWithOptions(AdminCustomerSearch custSearch, java.lang.String templateName, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3, java.lang.Object obj4, java.lang.Object obj5, int numberEmailThreads, AdminEmailOptions options) An email is sent to the customer.
void	setAvailableChars(java.lang.String availableChars)
protected void	setCustGroupCriteriaWithStandardAttributes(com.konakart.db.KKCriteria c) Set CustomerGroup criteria with standard attributes
void	setCustomerPassword(int customerId, java.lang.String password) Sets the customer password.
void	setCustomerPassword(int customerId, java.lang.String password, boolean forceChange, java.util.Calendar expiry) Set the customer password as well as the expiry date and whether the customer should be forced to change it
void	updateCustomer(AdminCustomer cust) We must update the following tables: customers, address_book (for the default address) and customers_info
int	updateCustomerGroup(AdminCustomerGroup custGroup) Update a customer group
protected void	updateCustomerReviews(int custId, java.sql.Connection con) Updates a customer's reviews by setting the custId to null.
void	updateCustomerWithOptions(AdminCustomer cust, AdminUpdateCustomerOptions options) We must update the following tables: customers, address_book (for the default address) and customers_info
void	updateVendor(AdminVendor vendor) Update the vendor
void	updateVendor(AdminVendor vendor, java.sql.Connection con) Update the vendor
void	updateVendorReviewInfo(int vendorId) The vendor referenced by the vendorId parameter is updated with information regarding the average rating and the number of reviews present for the vendor.

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

DEFAULT_DELETE_REVIEWS

protected static final boolean DEFAULT_DELETE_REVIEWS

default is to delete reviews

See Also:

Constant Field Values

availableLowerChars

protected static final java.lang.String availableLowerChars

Used for password generation

See Also:

Constant Field Values

availableUpperChars

protected static final java.lang.String availableUpperChars

Used for password generation

See Also:

Constant Field Values

availableSpecialChars

protected static final java.lang.String availableSpecialChars

Used for password generation

See Also:

Constant Field Values

availableNumericChars

protected static final java.lang.String availableNumericChars

Used for password generation

See Also:

Constant Field Values

DEFAULT_PASSWORD_CHARACTERS

protected static final java.lang.String DEFAULT_PASSWORD_CHARACTERS

Used for customer password generation

See Also:

Constant Field Values

availableChars

protected java.lang.String availableChars

Characters used for generating customer passwords - can be set in konakartadmin.properties

Constructor Detail

AdminCustomerMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getCustomersCount

public int getCustomersCount(AdminCustomerSearch search)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException,
                             KKAdminException

Returns a count of the number of Customers

Specified by:

getCustomersCount in interface AdminCustomerMgrIf

Parameters:

search - Search criteria

Returns:

A count of the number of Customers

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getCustomers

public AdminCustomerSearchResult getCustomers(AdminCustomerSearch custSearch,
                                              int offset,
                                              int size)
                                       throws java.lang.Exception

Returns a set of Customers that match the search criteria

Specified by:

getCustomers in interface AdminCustomerMgrIf

Parameters:

custSearch - the definition of the search for customers - can be null

offset - the offset in the db

size - the number of records from the specified offset

Returns:

a set of customers matching the search criteria

Throws:

java.lang.Exception - an unexpected exception

getCustomersLite

public AdminCustomerSearchResult getCustomersLite(AdminCustomerSearch custSearch,
                                                  int offset,
                                                  int size)
                                           throws KKAdminException

Returns a set of "Lite" Customers that match the search criteria. ONly a few attributes are populated on "Lite" Customers

Specified by:

getCustomersLite in interface AdminCustomerMgrIf

Parameters:

custSearch - the definition of the search for customers - can be null

offset - the offset in the db

size - the number of records from the specified offset

Returns:

a set of customers matching the search criteria within an AdminCustomerSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getDbPassword

public java.lang.String getDbPassword(int userId)
                               throws KKAdminException

Description copied from interface: AdminCustomerMgrIf

Get the password from the database for the given userId

Specified by:

getDbPassword in interface AdminCustomerMgrIf

Parameters:

userId - the userId

Returns:

the password from the database which is hashed

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getProductNotificationsForCustomer

public AdminProductNotification[] getProductNotificationsForCustomer(int customerId)
                                                              throws java.lang.Exception

Get an array of product notifications for the customer

Specified by:

getProductNotificationsForCustomer in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

Returns:

an array of product notifications for the customer

Throws:

java.lang.Exception - an unexpected exception

updateCustomer

public void updateCustomer(AdminCustomer cust)
                    throws java.lang.Exception

We must update the following tables: customers, address_book (for the default address) and customers_info

Specified by:

updateCustomer in interface AdminCustomerMgrIf

Parameters:

cust - the customer - must already have a good ID

Throws:

java.lang.Exception - an unexpected exception

updateCustomerWithOptions

public void updateCustomerWithOptions(AdminCustomer cust,
                                      AdminUpdateCustomerOptions options)
                               throws java.lang.Exception

We must update the following tables: customers, address_book (for the default address) and customers_info

Specified by:

updateCustomerWithOptions in interface AdminCustomerMgrIf

Parameters:

cust - the customer - must already have a good ID

options - the options

Throws:

java.lang.Exception - an unexpected exception

deleteCustomer

public int deleteCustomer(int custId)
                   throws java.lang.Exception

Deletes a customer from the database. If the property "delete_reviews" is set to "on" the reviews created by this customer will be removed. If not, the customerID associated with the reviews will be set to null but the reviews will remain.

Removes records from :

• REVIEWS_DESCRIPTION * see note above
• REVIEWS * see note above
• ADDRESS_BOOK
• CUSTOMERS
• CUSTOMERS_INFO
• CUSTOMERS_BASKET
• CUSTOMERS_BASKET_ATTRIBUTES
• WHOS_ONLINE
• KK_FILTER
• KK_WISHLIST
• KK_WISHLIST_ITEM

Parameters :

• custId

Specified by:

deleteCustomer in interface AdminCustomerMgrIf

Parameters:

custId - the custId

Returns:

returns the id of the deleted customer

Throws:

java.lang.Exception - an unexpected exception

deleteReviews

protected boolean deleteReviews()
                         throws KKAdminException

Utility method to return the konakart.delete_reviews property value

Returns:

Value of the property value (true or false)

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteCustomerReviews

protected void deleteCustomerReviews(int custId,
                                     java.sql.Connection con)
                              throws java.lang.Exception

Deletes a customer's reviews from the database. This is a dependent transaction - commits, rollbacks should be handled by the caller.

Removes records from :

• TABLE_REVIEWS_DESCRIPTION
• TABLE_REVIEWS

Parameters :

• custId customer ID
• con d/b Connection

Parameters:

custId - the custId

con - the con

Throws:

java.lang.Exception - an unexpected exception

updateCustomerReviews

protected void updateCustomerReviews(int custId,
                                     java.sql.Connection con)
                              throws java.lang.Exception

Updates a customer's reviews by setting the custId to null. This is a dependent transaction - commits, rollbacks should be handled by the caller.

Updates records from :

• TABLE_REVIEWS_DESCRIPTION
• TABLE_REVIEWS

Parameters :

• custId customer ID
• con d/b Connection

Parameters:

custId - the custId

con - the con

Throws:

java.lang.Exception - an unexpected exception

forceRegisterCustomer

public int forceRegisterCustomer(AdminCustomerRegistration custReg)
                          throws java.lang.Exception

Calls RegisterCustomerPrivate() with force set to true

Specified by:

forceRegisterCustomer in interface AdminCustomerMgrIf

Parameters:

custReg - the custReg

Returns:

Returns the customer id of the registered customer

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

public int registerCustomer(AdminCustomerRegistration custReg)
                     throws java.lang.Exception

Calls RegisterCustomerPrivate() with force set to false

Specified by:

registerCustomer in interface AdminCustomerMgrIf

Parameters:

custReg - the custReg

Returns:

Returns the customer id of the registered customer

Throws:

java.lang.Exception - an unexpected exception

registerCustomerPrivate

public int registerCustomerPrivate(AdminCustomerRegistration custReg,
                                   boolean force)
                            throws java.lang.Exception

A new customer is added to the system. The process for adding a new customer is to :

1. Insert information in the Customers table where a new primary key is generated
2. Insert address information in the address_book table
3. Update the customer record with the address id
4. Insert a customers_info record with the same PK as the customer

All of the above actions are performed as a transaction. In the case of MySQL, the transaction doesn't work unless the tables are defined as using the InnoDB or BDB engines. A table can be transformed using the following syntax : Alter table t Engine = InnoDB;. The standard engine seems to be MyIsam which doesn't support transactions.

Parameters:

custReg - the custReg

force - the force

Returns:

int : Customer Id

Throws:

java.lang.Exception - an unexpected exception

resetCustomerPasswordSpecifyingEmail

public void resetCustomerPasswordSpecifyingEmail(int custId,
                                                 java.lang.String eMailAddress)
                                          throws KKAdminException

Reset a customer's password using the eMail address specified. A new password is generated for the specified customer and an email is sent to the customer to inform him of this new password.

Specified by:

resetCustomerPasswordSpecifyingEmail in interface AdminCustomerMgrIf

Parameters:

custId - Customer Id

eMailAddress - The eMail address to override the one from the customer object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine if the customer is not found, or problems resetting the password or sending the email.

resetCustomerPassword

public void resetCustomerPassword(int custId)
                           throws KKAdminException

Reset a customer's password. A new password is generated for the specified customer and an email is sent to the customer to inform him of this new password.

Specified by:

resetCustomerPassword in interface AdminCustomerMgrIf

Parameters:

custId - Customer Id

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine if the customer is not found, the customer has no email address (which is used as the username), or problems resetting the password or sending the email.

resetCustomerPassword

protected void resetCustomerPassword(int custId,
                                     java.lang.String eMailAddr)
                              throws KKAdminException

Reset a customer's password. A new password is generated for the specified customer and an email is sent to the customer to inform him of this new password.

Parameters:

custId - Customer Id

eMailAddr - The eMail address to override the one from the customer object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine if the customer is not found, the customer has no email address (which is used as the username), or problems resetting the password or sending the email.

setCustomerPassword

public void setCustomerPassword(int customerId,
                                java.lang.String password)
                         throws java.lang.Exception

Sets the customer password.

Specified by:

setCustomerPassword in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

password - the password

Throws:

java.lang.Exception - an unexpected exception

setCustomerPassword

public void setCustomerPassword(int customerId,
                                java.lang.String password,
                                boolean forceChange,
                                java.util.Calendar expiry)
                         throws java.lang.Exception

Set the customer password as well as the expiry date and whether the customer should be forced to change it

Specified by:

setCustomerPassword in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

password - the password

forceChange - the forceChange

expiry - the expiry

Throws:

java.lang.Exception - an unexpected exception

getRandomPassword

public java.lang.String getRandomPassword(int length)
                                   throws java.lang.Exception

If length == 0, the configuration value ENTRY_PASSWORD_MIN_LENGTH is used.

Specified by:

getRandomPassword in interface AdminCustomerMgrIf

Parameters:

length - the length

Returns:

Returns a random password

Throws:

java.lang.Exception - an unexpected exception

doesZoneExist

protected boolean doesZoneExist(java.lang.String zoneDesc,
                                int countryId)
                         throws java.lang.Exception

If a country has at least one zone defined in the database, then we assume that all zones are defined and ensure that we only allow zones that are defined in the database. Otherwise we allow the user to register an address with any string as the zone.

Parameters:

zoneDesc - the zoneDesc

countryId - the countryId

Returns:

True if the zone exists in the country referenced by countryId or the country has no zones defined. Otherwise return false.

Throws:

java.lang.Exception - an unexpected exception

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

addCustomerOrderBy

protected void addCustomerOrderBy(com.konakart.db.KKCriteria c,
                                  AdminCustomerSearch custSearch)

Add Customer OrderBy

Parameters:

c - the c

custSearch - the custSearch

addCustomerSearchCriteria

protected int addCustomerSearchCriteria(com.konakart.db.KKCriteria c,
                                        AdminCustomerSearch custSearch,
                                        boolean addressJoin)
                                 throws KKAdminException

Adds search criteria to the query depending on what is in the custSearch object

Parameters:

c - The KKCriteria object

custSearch - The AdminCustomerSearch object

addressJoin - Set to true if the criteria already contains a join to the address table

Returns:

returns a count of the constraints added

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

getTagValue

protected java.lang.String getTagValue(java.lang.String value,
                                       int rule,
                                       java.lang.String preWildCard,
                                       java.lang.String postWildCard)

Utility method to return the formatted tag value

Parameters:

value - the value

rule - the rule

preWildCard - the preWildCard

postWildCard - the postWildCard

Returns:

Returns the formatted tag value

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)

doesCountryExist

protected boolean doesCountryExist(int countryId)
                            throws org.apache.torque.TorqueException,
                                   KKAdminException

Parameters:

countryId - the countryId

Returns:

True if the country referenced by countryId exists. Otherwise return false.

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

doesCustomerExistForEmail

public boolean doesCustomerExistForEmail(java.lang.String emailAddr)
                                  throws org.apache.torque.TorqueException,
                                         KKAdminException,
                                         com.workingdogs.village.DataSetException

Checks to see whether a registered customer already exists with this email address.

Specified by:

doesCustomerExistForEmail in interface AdminCustomerMgrIf

Parameters:

emailAddr - the emailAddr

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

doesCustomerExistForTelephone

public boolean doesCustomerExistForTelephone(java.lang.String telephone)
                                      throws org.apache.torque.TorqueException,
                                             KKAdminException,
                                             com.workingdogs.village.DataSetException

Checks to see whether a registered customer already exists with this telephone number.

Specified by:

doesCustomerExistForTelephone in interface AdminCustomerMgrIf

Parameters:

telephone - the telephone

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

doesCustomerExistForTelephone1

public boolean doesCustomerExistForTelephone1(java.lang.String telephone1)
                                       throws org.apache.torque.TorqueException,
                                              KKAdminException,
                                              com.workingdogs.village.DataSetException

Checks to see whether a registered customer already exists with this telephone 1 number.

Specified by:

doesCustomerExistForTelephone1 in interface AdminCustomerMgrIf

Parameters:

telephone1 - the telephone1

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

doesCustomerExistForUsername

public boolean doesCustomerExistForUsername(java.lang.String username)
                                     throws org.apache.torque.TorqueException,
                                            KKAdminException,
                                            com.workingdogs.village.DataSetException

Checks to see whether a registered customer already exists with this username.

Specified by:

doesCustomerExistForUsername in interface AdminCustomerMgrIf

Parameters:

username - the username

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

doesCustomerExistForId

public boolean doesCustomerExistForId(int custId)
                               throws org.apache.torque.TorqueException,
                                      KKAdminException

Checks to see whether a customer already exists with this id

Specified by:

doesCustomerExistForId in interface AdminCustomerMgrIf

Parameters:

custId - the custId

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

getCustomerForEmail

public AdminCustomer getCustomerForEmail(java.lang.String emailAddr)
                                  throws java.lang.Exception

Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.

Specified by:

getCustomerForEmail in interface AdminCustomerMgrIf

Parameters:

emailAddr - the emailAddr

Returns:

Returns a Customer object if the customer already exists

Throws:

java.lang.Exception - an unexpected exception

getCustomerForEmailWithOptions

public AdminCustomer getCustomerForEmailWithOptions(java.lang.String emailAddr,
                                                    AdminGetCustomerOptions options)
                                             throws java.lang.Exception

Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.

Specified by:

getCustomerForEmailWithOptions in interface AdminCustomerMgrIf

Parameters:

emailAddr - the emailAddr

options - Options allowing you to configure the API call in order to populate customer children when implementing a hierarchical customer structure.

Returns:

Returns a Customer object if the customer already exists

Throws:

java.lang.Exception - an unexpected exception

getCustomerForId

public AdminCustomer getCustomerForId(int customerId)
                               throws java.lang.Exception

Returns the customer object for the customer defined by the given id.

Specified by:

getCustomerForId in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

Returns:

Customer Object or Null if the customer doesn't exist.

Throws:

java.lang.Exception - an unexpected exception

getCustomerForIdWithOptions

public AdminCustomer getCustomerForIdWithOptions(int customerId,
                                                 AdminGetCustomerOptions options)
                                          throws java.lang.Exception

Returns the customer object for the customer defined by the given id.

Specified by:

getCustomerForIdWithOptions in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

options - Options allowing you to configure the API call in order to populate customer children when implementing a hierarchical customer structure.

Returns:

Customer Object or Null if the customer doesn't exist.

Throws:

java.lang.Exception - an unexpected exception

getCustomerIdForEmail

public int getCustomerIdForEmail(java.lang.String emailAddr)
                          throws org.apache.torque.TorqueException,
                                 KKAdminException,
                                 com.workingdogs.village.DataSetException

Description copied from interface: AdminCustomerMgrIf

Finds the custId of the specified customer.

Specified by:

getCustomerIdForEmail in interface AdminCustomerMgrIf

Parameters:

emailAddr - the emailAddr

Returns:

Returns the customerId of the specified customer or -1 if the customer isn't found.

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getAddressFormatTemplate

public java.lang.String getAddressFormatTemplate(int id)
                                          throws org.apache.torque.TorqueException,
                                                 com.workingdogs.village.DataSetException,
                                                 KKAdminException

Does a query on the address_format table

Specified by:

getAddressFormatTemplate in interface AdminCustomerMgrIf

Parameters:

id - the id

Returns:

Returns the template referenced by the id parameter

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

getAllAddressFormats

public AdminAddressFormat[] getAllAddressFormats()
                                          throws KKAdminException

This returns an array of all the address formats

Specified by:

getAllAddressFormats in interface AdminCustomerMgrIf

Returns:

Returns an array of all the address formats

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

sendTemplateEmailToCustomers

public void sendTemplateEmailToCustomers(AdminCustomerSearch custSearch,
                                         java.lang.String templateName,
                                         java.lang.Object obj1,
                                         java.lang.Object obj2,
                                         java.lang.Object obj3,
                                         java.lang.Object obj4,
                                         java.lang.Object obj5,
                                         int numberEmailThreads)
                                  throws org.apache.torque.TorqueException,
                                         com.workingdogs.village.DataSetException,
                                         java.lang.Exception

Calls sendTemplateEmailToCustomersWithOptions() with null options.

Specified by:

sendTemplateEmailToCustomers in interface AdminCustomerMgrIf

Parameters:

custSearch - The AdminCustomerSearch object which determines the customers that are selected.

templateName - The name of the template. The country code and .vm will be appended automatically. i.e. If the template name is newsletter and the country code is en, then we will look for a file called newsletter_en.vm.

obj1 - This object will be passed to the velocity template with the name obj1.

obj2 - This object will be passed to the velocity template with the name obj2.

obj3 - This object will be passed to the velocity template with the name obj3.

obj4 - This object will be passed to the velocity template with the name obj4.

obj5 - This object will be passed to the velocity template with the name obj5.

numberEmailThreads - The number of concurrent threads that will be used to send the emails.

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)

java.lang.Exception - an unexpected Exception exception

sendTemplateEmailToCustomersWithOptions

public void sendTemplateEmailToCustomersWithOptions(AdminCustomerSearch custSearch,
                                                    java.lang.String templateName,
                                                    java.lang.Object obj1,
                                                    java.lang.Object obj2,
                                                    java.lang.Object obj3,
                                                    java.lang.Object obj4,
                                                    java.lang.Object obj5,
                                                    int numberEmailThreads,
                                                    AdminEmailOptions options)
                                             throws org.apache.torque.TorqueException,
                                                    com.workingdogs.village.DataSetException,
                                                    java.lang.Exception

An email is sent to the customer. The email is generated by the template called templateName and the objects obj1-obj5 are passed to the template. The subject of the eMail is picked up from the first line of the template.

Specified by:

sendTemplateEmailToCustomersWithOptions in interface AdminCustomerMgrIf

Parameters:

custSearch - The AdminCustomerSearch object which determines the customers that are selected.

templateName - The name of the template. The country code and .vm will be appended automatically. i.e. If the template name is newsletter and the country code is en, then we will look for a file called newsletter_en.vm.

obj1 - This object will be passed to the velocity template with the name obj1.

obj2 - This object will be passed to the velocity template with the name obj2.

obj3 - This object will be passed to the velocity template with the name obj3.

obj4 - This object will be passed to the velocity template with the name obj4.

obj5 - This object will be passed to the velocity template with the name obj5.

numberEmailThreads - The number of concurrent threads that will be used to send the emails.

options - An object used to configure options used when sending eMails from the AdminApp

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)

java.lang.Exception - an unexpected exception

insertProductNotification

public void insertProductNotification(int custId,
                                      int prodId)
                               throws KKAdminException

Insert a Product Notification record for the specified customer and product.

Specified by:

insertProductNotification in interface AdminCustomerMgrIf

Parameters:

custId - the customerId

prodId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

deleteProductNotification

public void deleteProductNotification(int custId,
                                      int prodId)
                               throws KKAdminException

Delete a Product Notification record for the specified customer and product if it's found.

Specified by:

deleteProductNotification in interface AdminCustomerMgrIf

Parameters:

custId - the customerId

prodId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

getCustomerGroupsPerPromotion

public AdminCustomerGroup[] getCustomerGroupsPerPromotion(int promotionId,
                                                          int languageId)
                                                   throws java.lang.Exception

Returns all of the customer groups for the promotion

Specified by:

getCustomerGroupsPerPromotion in interface AdminCustomerMgrIf

Parameters:

promotionId - the promotionId

languageId - the languageId

Returns:

Array of AdminCustomerGroup Objects

Throws:

java.lang.Exception - an unexpected exception

insertCustomerGroup

public int insertCustomerGroup(AdminCustomerGroup custGroup)
                        throws KKAdminException,
                               org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException

Insert a customer group

Specified by:

insertCustomerGroup in interface AdminCustomerMgrIf

Parameters:

custGroup - A customer group object

Returns:

returns the id of the inserted customer group

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine 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)

insertCustomerGroups

public int insertCustomerGroups(AdminCustomerGroup[] custGroups)
                         throws KKAdminException,
                                org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException

Insert an array of AdminCustomerGroup objects. We calculate and use the same id for all of the items in the array so you must ensure that each item has a unique language id, otherwise the DB will throw an exception.

Specified by:

insertCustomerGroups in interface AdminCustomerMgrIf

Parameters:

custGroups - An array of AdminCustomerGroup objects

Returns:

returns the id of the inserted objects

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

updateCustomerGroup

public int updateCustomerGroup(AdminCustomerGroup custGroup)
                        throws KKAdminException,
                               org.apache.torque.TorqueException

Update a customer group

Specified by:

updateCustomerGroup in interface AdminCustomerMgrIf

Parameters:

custGroup - A customer group object

Returns:

Returns the id of the customer group

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

deleteCustomerGroup

public int deleteCustomerGroup(int custGroupId)
                        throws java.lang.Exception

Delete a Customer Group. The method may actually delete multiple database records if the customer group has entries for different languages.

Specified by:

deleteCustomerGroup in interface AdminCustomerMgrIf

Parameters:

custGroupId - The id of a customer group object

Returns:

returns the id of the deleted customer group

Throws:

java.lang.Exception - an unexpected exception

getCustomerGroups

public AdminCustomerGroupSearchResult getCustomerGroups(AdminCustomerGroupSearch search)
                                                 throws org.apache.torque.TorqueException,
                                                        com.workingdogs.village.DataSetException,
                                                        KKAdminException

This returns an AdminCustomerGroupSearchResult object.

Specified by:

getCustomerGroups in interface AdminCustomerMgrIf

Parameters:

search - the search

Returns:

Returns an AdminCustomerGroupSearchResult 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)

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

addCustomerGroupSearchCriteria

protected int addCustomerGroupSearchCriteria(com.konakart.db.KKCriteria c,
                                             AdminCustomerGroupSearch search)
                                      throws KKAdminException

Parameters:

c - the c

search - the search

Returns:

number of constraints added to the criteria

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

setCustGroupCriteriaWithStandardAttributes

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

Set CustomerGroup criteria with standard attributes

Parameters:

c - the c

addCustomerGroupOrderBy

protected void addCustomerGroupOrderBy(com.konakart.db.KKCriteria c,
                                       AdminCustomerGroupSearch search)

Add CustomerGroup OrderBy

Parameters:

c - the c

search - the search

incrementLogonCount

public void incrementLogonCount(int customerId)
                         throws org.apache.torque.TorqueException,
                                KKAdminException,
                                com.workingdogs.village.DataSetException

This method increments the logon count attribute of the customers_info table and sets the last logged in date for the customer..

Specified by:

incrementLogonCount in interface AdminCustomerMgrIf

Parameters:

customerId - the customerId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine unexpected exception in the KonaKart Admin Engine

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

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Manager

Specified by:

refreshConfigs in interface AdminCustomerMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception

createMailingList

public void createMailingList(AdminCustomerSearch search,
                              AdminMailListOptions listOptions)
                       throws KKAdminException

Description copied from interface: AdminCustomerMgrIf

Create a mailing list file on disk that contains a record for every customer defined by the AdminCustomerSearch object.

Specified by:

createMailingList in interface AdminCustomerMgrIf

Parameters:

search - Customer search object - defines the set of customers to be included in the mailing list to be created

listOptions - Mailing List Options - defines options about the mailing list to be created such as its format and its name.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAvailableChars

public java.lang.String getAvailableChars()

Returns:

the availableChars

setAvailableChars

public void setAvailableChars(java.lang.String availableChars)

Parameters:

availableChars - the availableChars to set

populateCustomerChildren

public void populateCustomerChildren(AdminCustomer[] parents,
                                     boolean recursive)
                              throws java.lang.Exception

Populates the child customers of the array of parent customers passed in as a parameter.

Parameters:

parents - An array of parent customers

recursive - When set to true the population is recursive to retrieve the whole of the child tree.

Throws:

java.lang.Exception - an unexpected exception

populateCustomerParents

public void populateCustomerParents(AdminCustomer[] customers)
                             throws java.lang.Exception

Populates the parent customer of the customers passed in as a parameter

Parameters:

customers - An array of customers

Throws:

java.lang.Exception - an unexpected exception

addChildrenToCustomer

public void addChildrenToCustomer(int parentId,
                                  AdminCustomer[] children)
                           throws java.lang.Exception

The array of AdminCustomer children objects are given the parent id passed in as a parameter. Any existing child of the parent that isn't in the array, is deleted. Only the id of the children objects needs to be populated.

Specified by:

addChildrenToCustomer in interface AdminCustomerMgrIf

Parameters:

parentId - ParentId set on the AdminCustomer children objects passed in as a parameter

children - An array of AdminCustomer objects

Throws:

java.lang.Exception - an unexpected exception

checkUniquenessForRegistration

public void checkUniquenessForRegistration(AdminCustomerRegistration custReg,
                                           boolean force)
                                    throws java.lang.Exception

Check uniqueness for the username, telephone and telephone1

Parameters:

custReg - the custReg

force - the force

Throws:

java.lang.Exception - an unexpected exception

checkUniquenessForUpdate

public void checkUniquenessForUpdate(AdminUpdateCustomerOptions options,
                                     AdminCustomer currentCust,
                                     AdminCustomer cust)
                              throws java.lang.Exception

Check uniqueness for the username, telephone and telephone1

Parameters:

options - the options

currentCust - The current customer referred to by the session id

cust - The object containing the new customer data

Throws:

java.lang.Exception - an unexpected exception

getVendors

public AdminVendorSearchResult getVendors(AdminVendorSearch vendorSearch,
                                          int offset,
                                          int size)
                                   throws java.lang.Exception

Returns a set of Vendors that match the search criteria

Specified by:

getVendors in interface AdminCustomerMgrIf

Parameters:

vendorSearch - the definition of the search for vendors - can be null

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns a set of vendors matching the search criteria

Throws:

java.lang.Exception - an unexpected exception

getVendorForId

public AdminVendor getVendorForId(int vendorId)
                           throws java.lang.Exception

Return a vendor for the numeric vendorId

Specified by:

getVendorForId in interface AdminCustomerMgrIf

Parameters:

vendorId - the vendorId

Returns:

Returns the vendor for the id or null if no vendor is found

Throws:

java.lang.Exception - an unexpected exception

updateVendor

public void updateVendor(AdminVendor vendor)
                  throws java.lang.Exception

Update the vendor

Specified by:

updateVendor in interface AdminCustomerMgrIf

Parameters:

vendor - the vendor - must already have a good ID

Throws:

java.lang.Exception - an unexpected exception

updateVendor

public void updateVendor(AdminVendor vendor,
                         java.sql.Connection con)
                  throws java.lang.Exception

Update the vendor

Specified by:

updateVendor in interface AdminCustomerMgrIf

Parameters:

vendor - the vendor - must already have a good ID

con - The connection in order to perform the update within an existing transaction

Throws:

java.lang.Exception - an unexpected exception

insertVendor

public int insertVendor(AdminVendor vendor)
                 throws java.lang.Exception

Insert a vendor

Specified by:

insertVendor in interface AdminCustomerMgrIf

Parameters:

vendor - the vendor

Returns:

Returns the id of the inserted vendor

Throws:

java.lang.Exception - an unexpected exception

deleteVendor

public void deleteVendor(int vendorId)
                  throws java.lang.Exception

Delete a vendor

Specified by:

deleteVendor in interface AdminCustomerMgrIf

Parameters:

vendorId - the vendorId

Throws:

java.lang.Exception - an unexpected exception

updateVendorReviewInfo

public void updateVendorReviewInfo(int vendorId)
                            throws java.lang.Exception

The vendor referenced by the vendorId parameter is updated with information regarding the average rating and the number of reviews present for the vendor.

Specified by:

updateVendorReviewInfo in interface AdminCustomerMgrIf

Parameters:

vendorId - the vendorId

Throws:

java.lang.Exception - an unexpected exception

addVendorToStore

public void addVendorToStore(int vendorId,
                             java.lang.String vendorStoreId)
                      throws java.lang.Exception

Associates a vendor with a store

Specified by:

addVendorToStore in interface AdminCustomerMgrIf

Parameters:

vendorId - the vendorId

vendorStoreId - the vendorStoreId

Throws:

java.lang.Exception - an unexpected exception

cloneCustomer

public AdminCloneCustomerResult cloneCustomer(int superUserId,
                                              int cloneCustId,
                                              java.lang.String[] stores)
                                       throws java.lang.Exception

Description copied from interface: AdminCustomerMgrIf

This API call is used to clone customers across multiple stores and is only available when in multi-store single DB, non shared customer mode. The caller (referenced by superUserId) must have at least one role with super user privileges. The cloneCustId references an existing customer in the current engine store. If a customer with matching eMail address doesn't exist in a destination store, a new customer object is inserted, otherwise the existing object is updated.

Points to note:

• The cloned customer has the same password as the source customer
• All addresses and roles are also cloned
• Customer tag information is cloned as long as the customer tag exists in the destination store
• The return object contains an array of error messages. If an error occurs when cloning to a store, the exception is trapped, reported in the return object and the code continues with the next store.

Specified by:

cloneCustomer in interface AdminCustomerMgrIf

Parameters:

superUserId - The id of the Super User making the API call

cloneCustId - The id of the customer to be cloned

stores - An array of destination store ids where the customer will be cloned

Returns:

Returns an AdminCloneCustomerResult object

Throws:

java.lang.Exception - an unexpected exception

deleteCustomerMultiStore

public AdminDeleteCustomerResult deleteCustomerMultiStore(int superUserId,
                                                          int customerId,
                                                          java.lang.String[] stores)
                                                   throws java.lang.Exception

Description copied from interface: AdminCustomerMgrIf

This API call is used to delete customers across multiple stores and is only available when in multi-store single DB, non shared customer mode. The caller (referenced by superUserId) must have at least one role with super user privileges. The customerId references an existing customer in the current engine store. If a customer with matching eMail address exists in a destination store, the customer is deleted.

If the stores array contains the id of the KKAdmin Engine store, then the customer is also deleted from that store.

Specified by:

deleteCustomerMultiStore in interface AdminCustomerMgrIf

Parameters:

superUserId - The id of the Super User making the API call

customerId - The id of the customer to be deleted

stores - An array of store ids where the customer will be deleted

Returns:

Returns an AdminDeleteCustomerResult object

Throws:

java.lang.Exception - an unexpected exception

getStoresForCustomer

public AdminStore[] getStoresForCustomer(int superUserId,
                                         java.lang.String emailAddress)
                                  throws java.lang.Exception

Description copied from interface: AdminCustomerMgrIf

This API call is only available when in multi-store single DB, non shared customer mode. The caller (referenced by sessionId) must have at least one role with super user privileges.

It is used to search for a customer using the email address, across multiple stores. The stores where the customer is present, are returned in an array in alphabetical order. It searches all stores regardless of their state (enabled, under maintenance or deleted). This state information is available on the returned AdminStore objects.

Specified by:

getStoresForCustomer in interface AdminCustomerMgrIf

Parameters:

superUserId - The id of the Super User making the API call

emailAddress - The email address of the customer being searched

Returns:

Returns an array of AdminStores. An empty array is returned if there are no stores.

Throws:

java.lang.Exception - an unexpected exception