com.konakartadmin.bl

Class AdminCustomerMgrEE

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminCustomerMgr

com.konakartadmin.bl.AdminCustomerMgrEE

All Implemented Interfaces:

AdminCustomerMgrIf

public class AdminCustomerMgrEE
extends AdminCustomerMgr
implements AdminCustomerMgrIf

The AdminCustomerMgrEE - for Managing Customer Objects for the Admin Application - Enterprise Features

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminCustomerMgrEE.CustomerComparator Used to sort the Customers by their second name

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

AdminBaseMgr.StaticData

Field Summary

Fields inherited from class com.konakartadmin.bl.AdminCustomerMgr

availableChars, availableLowerChars, availableNumericChars, availableSpecialChars, availableUpperChars, DEFAULT_DELETE_REVIEWS, DEFAULT_PASSWORD_CHARACTERS, 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
AdminCustomerMgrEE(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	addVendorOrderBy(com.konakart.db.KKCriteria c, AdminVendorSearch vendorSearch) Add Vendor OrderBy
protected int	addVendorSearchCriteria(com.konakart.db.KKCriteria c, AdminVendorSearch vendorSearch) Adds search criteria to the query depending on what is in the vendorSearch 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.
private java.lang.String	csvItem(java.lang.String item) Write a safe CSV item.
int	deleteCustomer(int custId) Calls super.deleteCustomer() and writes an updateObject message to the queue if enabled.
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.
void	deleteVendor(int vendorId) Delete a vendor
boolean	doesVendorExist(int vendorId) Return true if the vendor exists.
private java.lang.String	escapeDoubleQuotes(java.lang.String in)
protected AdminCountry	getDestCountry(KKAdminIf destEng, AdminCountry sourceCountry, java.lang.String store) Utility method that returns the country object for the destination country.
protected AdminZone	getDestZone(KKAdminIf destEng, AdminCountry destCountry, AdminZone sourceZone, java.lang.String store) Utility method that returns the zone object for the destination zone.
protected int	getSessionExpiryTimeInSecs() Utility method to create a session expiry time
protected AdminCountry	getSourceCountry(AdminTaxMgrIf taxMgr, java.util.HashMap<java.lang.Integer,AdminCountry> sourceCountryMap, int countryId) Utility method that returns the country object for the source country.
protected AdminZone	getSourceZone(AdminTaxMgrIf taxMgr, java.util.HashMap<java.lang.Integer,AdminZone> sourceZoneMap, int zoneId) Utility method that returns the zone object for the source zone.
AdminStore[]	getStoresForCustomer(int superUserId, java.lang.String emailAddress) This API call is only available when in multi-store single DB, non shared customer mode.
int	getVendorCount(AdminVendorSearch search) Returns a count of the number of Vendors
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
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.
protected void	populateCustomerChildren(AdminCustomer[] parents, boolean recursive, java.util.HashMap<java.lang.Integer,java.lang.String> idMap) 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 super.registerCustomer() and writes an updateObject message to the queue if enabled.
void	updateCustomerWithOptions(AdminCustomer cust, AdminUpdateCustomerOptions options) Calls super.updateCustomerWithOptions() and writes an updateObject message to the queue if enabled.
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.
protected void	writeMailingListFooter(java.io.BufferedWriter bw, int outputFormat) Write the heading depending on the output format
protected void	writeMailingListHeading(java.io.BufferedWriter bw, int outputFormat) Write the heading depending on the output format
protected void	writeMailingListRow(java.io.BufferedWriter bw, int outputFormat, AdminCustomer cust) Write the heading depending on the output format

Methods inherited from class com.konakartadmin.bl.AdminCustomerMgr

addCustomerGroupOrderBy, addCustomerGroupSearchCriteria, addCustomerOrderBy, addCustomerSearchCriteria, deleteCustomerGroup, deleteCustomerReviews, deleteProductNotification, deleteReviews, doesCountryExist, doesCustomerExistForEmail, doesCustomerExistForId, doesCustomerExistForTelephone, doesCustomerExistForTelephone1, doesCustomerExistForUsername, doesZoneExist, forceRegisterCustomer, getAddressFormatTemplate, getAllAddressFormats, getAvailableChars, getCount, getCustomerForEmail, getCustomerForEmailWithOptions, getCustomerForId, getCustomerForIdWithOptions, getCustomerGroups, getCustomerGroupsPerPromotion, getCustomerIdForEmail, getCustomers, getCustomersCount, getCustomersLite, getDbPassword, getProductNotificationsForCustomer, getRandomPassword, getTagValue, incrementLogonCount, insertCustomerGroup, insertCustomerGroups, insertProductNotification, registerCustomerPrivate, resetCustomerPassword, resetCustomerPassword, resetCustomerPasswordSpecifyingEmail, sendTemplateEmailToCustomers, sendTemplateEmailToCustomersWithOptions, setAvailableChars, setCustGroupCriteriaWithStandardAttributes, setCustomerPassword, setCustomerPassword, updateCustomer, updateCustomerGroup, updateCustomerReviews

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

Methods inherited from interface com.konakartadmin.blif.AdminCustomerMgrIf

deleteCustomerGroup, deleteProductNotification, doesCustomerExistForEmail, doesCustomerExistForId, doesCustomerExistForTelephone, doesCustomerExistForTelephone1, doesCustomerExistForUsername, forceRegisterCustomer, getAddressFormatTemplate, getAllAddressFormats, getCustomerForEmail, getCustomerForEmailWithOptions, getCustomerForId, getCustomerForIdWithOptions, getCustomerGroups, getCustomerGroupsPerPromotion, getCustomerIdForEmail, getCustomers, getCustomersCount, getCustomersLite, getDbPassword, getProductNotificationsForCustomer, getRandomPassword, incrementLogonCount, insertCustomerGroup, insertCustomerGroups, insertProductNotification, resetCustomerPassword, resetCustomerPasswordSpecifyingEmail, sendTemplateEmailToCustomers, sendTemplateEmailToCustomersWithOptions, setCustomerPassword, setCustomerPassword, updateCustomer, updateCustomerGroup

Constructor Detail

AdminCustomerMgrEE

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

Constructor

Parameters:

eng - the Admin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Manager

Specified by:

refreshConfigs in interface AdminCustomerMgrIf

Overrides:

refreshConfigs in class AdminCustomerMgr

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

Overrides:

createMailingList in class AdminCustomerMgr

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

writeMailingListHeading

protected void writeMailingListHeading(java.io.BufferedWriter bw,
                                       int outputFormat)
                                throws java.io.IOException

Write the heading depending on the output format

Parameters:

bw - the bw

outputFormat - the outputFormat

Throws:

java.io.IOException - an unexpected IOException exception

writeMailingListRow

protected void writeMailingListRow(java.io.BufferedWriter bw,
                                   int outputFormat,
                                   AdminCustomer cust)
                            throws java.io.IOException

Write the heading depending on the output format

Parameters:

bw - the bw

outputFormat - the outputFormat

cust - the Customer record

Throws:

java.io.IOException - an unexpected IOException exception

writeMailingListFooter

protected void writeMailingListFooter(java.io.BufferedWriter bw,
                                      int outputFormat)
                               throws java.io.IOException

Write the heading depending on the output format

Parameters:

bw - the bw

outputFormat - the outputFormat

Throws:

java.io.IOException - an unexpected IOException exception

csvItem

private java.lang.String csvItem(java.lang.String item)

Write a safe CSV item. If there are embedded commas we must surround with double quotes. If we surround with double quotes we must also escape embedded double quotes by doubling up.

Parameters:

item - the item

Returns:

a safe CSV item

escapeDoubleQuotes

private java.lang.String escapeDoubleQuotes(java.lang.String in)

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.

Overrides:

populateCustomerChildren in class AdminCustomerMgr

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

populateCustomerChildren

protected void populateCustomerChildren(AdminCustomer[] parents,
                                        boolean recursive,
                                        java.util.HashMap<java.lang.Integer,java.lang.String> idMap)
                                 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.

idMap - Hash map to stop recursion

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

Overrides:

addChildrenToCustomer in class AdminCustomerMgr

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

populateCustomerParents

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

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

Overrides:

populateCustomerParents in class AdminCustomerMgr

Parameters:

customers - An array of customers

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

Overrides:

checkUniquenessForRegistration in class AdminCustomerMgr

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

Overrides:

checkUniquenessForUpdate in class AdminCustomerMgr

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

insertVendor

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

Insert a vendor

Specified by:

insertVendor in interface AdminCustomerMgrIf

Overrides:

insertVendor in class AdminCustomerMgr

Parameters:

vendor - the vendor

Returns:

Returns the id of the inserted vendor

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

Overrides:

updateVendor in class AdminCustomerMgr

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

Overrides:

updateVendor in class AdminCustomerMgr

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

deleteVendor

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

Delete a vendor

Specified by:

deleteVendor in interface AdminCustomerMgrIf

Overrides:

deleteVendor in class AdminCustomerMgr

Parameters:

vendorId - the vendorId

Throws:

java.lang.Exception - an unexpected exception

doesVendorExist

public boolean doesVendorExist(int vendorId)
                        throws KKAdminException,
                               org.apache.torque.TorqueException

Return true if the vendor exists.

Parameters:

vendorId - the vendorId

Returns:

True if the vendor exists

Throws:

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

KKAdminException - unexpected exception in the KonaKart Admin Engine

getVendorForId

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

Return a vendor for the numeric vendorId

Specified by:

getVendorForId in interface AdminCustomerMgrIf

Overrides:

getVendorForId in class AdminCustomerMgr

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

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

Overrides:

getVendors in class AdminCustomerMgr

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

getVendorCount

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

Returns a count of the number of Vendors

Parameters:

search - Search criteria

Returns:

A count of the number of Vendors

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 - unexpected exception in the KonaKart Admin Engine

addVendorSearchCriteria

protected int addVendorSearchCriteria(com.konakart.db.KKCriteria c,
                                      AdminVendorSearch vendorSearch)
                               throws KKAdminException

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

Parameters:

c - The KKCriteria object

vendorSearch - The AdminVendorSearch object

Returns:

returns a count of the constraints added

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

addVendorOrderBy

protected void addVendorOrderBy(com.konakart.db.KKCriteria c,
                                AdminVendorSearch vendorSearch)

Add Vendor OrderBy

Parameters:

c - the c

vendorSearch - the vendorSearch

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

Overrides:

updateVendorReviewInfo in class AdminCustomerMgr

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

Overrides:

addVendorToStore in class AdminCustomerMgr

Parameters:

vendorId - the vendorId

vendorStoreId - the vendorStoreId

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

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

Calls super.registerCustomer() and writes an updateObject message to the queue if enabled.

Specified by:

registerCustomer in interface AdminCustomerMgrIf

Overrides:

registerCustomer in class AdminCustomerMgr

Parameters:

custReg - the custReg

Returns:

Returns the customer id of the registered customer

Throws:

java.lang.Exception - an unexpected exception

updateCustomerWithOptions

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

Calls super.updateCustomerWithOptions() and writes an updateObject message to the queue if enabled.

Specified by:

updateCustomerWithOptions in interface AdminCustomerMgrIf

Overrides:

updateCustomerWithOptions in class AdminCustomerMgr

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

Calls super.deleteCustomer() and writes an updateObject message to the queue if enabled.

Specified by:

deleteCustomer in interface AdminCustomerMgrIf

Overrides:

deleteCustomer in class AdminCustomerMgr

Parameters:

custId - the custId

Returns:

returns the id of the deleted customer

Throws:

java.lang.Exception - an unexpected exception

cloneCustomer

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

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

Overrides:

cloneCustomer in class AdminCustomerMgr

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

getSourceCountry

protected AdminCountry getSourceCountry(AdminTaxMgrIf taxMgr,
                                        java.util.HashMap<java.lang.Integer,AdminCountry> sourceCountryMap,
                                        int countryId)
                                 throws KKAdminException,
                                        org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException

Utility method that returns the country object for the source country. Gets it from a map if it has already been looked up.

Parameters:

taxMgr - the taxMgr

sourceCountryMap - the sourceCountryMap

countryId - the countryId

Returns:

Returns an AdminCountry object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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

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

getSourceZone

protected AdminZone getSourceZone(AdminTaxMgrIf taxMgr,
                                  java.util.HashMap<java.lang.Integer,AdminZone> sourceZoneMap,
                                  int zoneId)
                           throws KKAdminException,
                                  org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException

Utility method that returns the zone object for the source zone. Gets it from a map if it has already been looked up.

Parameters:

taxMgr - the taxMgr

sourceZoneMap - the sourceZoneMap

zoneId - the zoneId

Returns:

Returns an AdminZone object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

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

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

getDestCountry

protected AdminCountry getDestCountry(KKAdminIf destEng,
                                      AdminCountry sourceCountry,
                                      java.lang.String store)
                               throws KKAdminException

Utility method that returns the country object for the destination country.

Parameters:

destEng - the destEng

sourceCountry - the sourceCountry

store - the store

Returns:

Returns an AdminCountry object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getDestZone

protected AdminZone getDestZone(KKAdminIf destEng,
                                AdminCountry destCountry,
                                AdminZone sourceZone,
                                java.lang.String store)
                         throws KKAdminException

Utility method that returns the zone object for the destination zone.

Parameters:

destEng - the destEng

destCountry - the destCountry

sourceZone - the sourceZone

store - the store

Returns:

Returns an AdminZone object

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getSessionExpiryTimeInSecs

protected int getSessionExpiryTimeInSecs()

Utility method to create a session expiry time

Returns:

Returns an expiry time in seconds

deleteCustomerMultiStore

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

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

Overrides:

deleteCustomerMultiStore in class AdminCustomerMgr

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

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

Overrides:

getStoresForCustomer in class AdminCustomerMgr

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