CustomerMgr (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.bl.BaseMgr
- - com.konakart.bl.CustomerMgr

All Implemented Interfaces:

CustomerMgrIf

Direct Known Subclasses:

CustomerMgrEE
```
public class CustomerMgr
extends BaseMgr
implements CustomerMgrIf
```
Customer Manager

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class CustomerMgr.StaticData
Used to store the static data of this manager

Nested Classes
Modifier and Type	Class and Description
`protected class`	`CustomerMgr.StaticData` Used to store the static data of this manager

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CUST_TYPE_ADMIN_USER` An Admin user
`static int`	`CUST_TYPE_B2B_COMPANY_ADMIN` B2B Company Admin
`static int`	`CUST_TYPE_DEFAULT_CUST` Default customer
`static int`	`CUST_TYPE_NON_REGISTERED_CUST` A customer that hasn't registered
`static int`	`CUST_TYPE_REGISTERED_CUST` A customer that has registered normally
`protected static boolean`	`DEFAULT_DELETE_REVIEWS` Default value for the konakart.delete_reviews property
`static java.util.GregorianCalendar`	`DEFAULT_DOB` Default value written to DB when not available
`static java.lang.String`	`DEFAULT_STRING` Default value written to DB when not available
`static java.lang.String`	`DEFAULT_STRING_SHORT` Default value written to DB when not available
`protected static org.apache.commons.logging.Log`	`log` the log
`protected static java.lang.String`	`mutex` mutex
`protected static java.util.Map<java.lang.String,CustomerMgr.StaticData>`	`staticDataHM` Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr
templateBaseDir

Constructor Summary

Constructors
Constructor and Description

CustomerMgr(KKEngIf eng)
Constructor

Constructors
Constructor and Description
`CustomerMgr(KKEngIf eng)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addAddressToCustomer(java.lang.String sessionId, AddressIf addr)` The Address object is added to the customer defined by the SessionId.
`int`	`addCreditCardToCustomer(CreditCardIf card, CreditCardOptionsIf options)` Inserts a CreditCard object into the database.
`int`	`addCreditCardToCustomer(java.lang.String sessionId, CreditCardIf card, CreditCardOptionsIf options)` Inserts a CreditCard object into the database.
`void`	`addCustomerNotifications(NotificationOptionsIf options)` A method that allows you sign up a customer for a newsletter or product notification.
`protected void`	`addProductNotificationToCustomer(int customerId, int productId)`
`void`	`addProductNotificationToCustomer(java.lang.String sessionId, int productId)` Adds a product notification to the customer referenced by the session id
`void`	`checkUniquenessForEdit(EditCustomerOptionsIf options, CustomerIf currentCust, CustomerIf cust)` Check uniqueness for the username, telephone and telephone1
`void`	`checkUniquenessForRegistration(CustomerRegistrationIf custReg, boolean force)` Check uniqueness for the username, telephone and telephone1
`void`	`checkUniquenessForRegistration(CustomerRegistrationIf custReg, boolean force, java.sql.Connection con)` Check uniqueness for the username, telephone and telephone1
`void`	`deleteAddressFromCustomer(java.lang.String sessionId, int addressId)` The address defined by customerId and addressId is deleted.
`void`	`deleteCreditCard(int customerId, int cardId)` Deletes the credit card referenced by cardId that must belong to the customer with id customerId
`void`	`deleteCreditCard(java.lang.String sessionId, int cardId)` Deletes the credit card referenced by cardId that must belong to the logged in customer.
`void`	`deleteCustomer(int custId)` Deletes a customer from the database.
`void`	`deleteCustomerNotifications(NotificationOptionsIf options)` A method that allows you remove a customer notification for a newsletter or product.
`protected void`	`deleteCustomerReviews(int custId, java.sql.Connection con)` Deletes a customer's reviews from the database.
`void`	`deleteProductNotificationFromCustomer(int customerId, int productId)`
`void`	`deleteProductNotificationFromCustomer(java.lang.String sessionId, int productId)` Deletes a product notification from the customer referenced by the session id
`protected boolean`	`deleteReviews()` Utility method to return the konakart.delete_reviews property value
`protected boolean`	`doesCountryExist(int countryId)` Does the Country Exist?
`protected boolean`	`doesCountryExist(int countryId, java.sql.Connection con)` Does the Country Exist?
`boolean`	`doesCustomerExistForEmail(java.lang.String emailAddr)` Checks to see whether a registered customer already exists with this email address.
`protected 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.
`boolean`	`doesVendorExist(int vendorId)` Figure out whether a vendor exists
`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.
`boolean`	`doesZoneExist(java.lang.String zoneDesc, int countryId, java.sql.Connection con)` 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.
`void`	`editCreditCard(java.lang.String sessionId, CreditCardIf card, CreditCardOptionsIf options)` Edit the credit card of a logged in customer referenced by sessionId.
`void`	`editCustomer(java.lang.String sessionId, CustomerIf cust)` Updates the customer data with the data in the Customer object passed in as a parameter.
`void`	`editCustomerAddress(java.lang.String sessionId, AddressIf addr)` The Address object will replace the existing address object in the database with the same id.
`void`	`editCustomerWithOptions(java.lang.String sessionId, CustomerIf cust, EditCustomerOptionsIf options)` Updates the customer data with the data in the Customer object passed in as a parameter.
`void`	`enableCustomer(int customerId)` Enables the customer identified by the customer id.
`void`	`escapeAddress(AddressIf addr)` Escape the Strings in the Address object using the rules defined in the properties file by the property konakart.escape.chars .
`void`	`escapeCustomer(CustomerIf cust)` Escape the Strings in the Customer object using the rules defined in the properties file by the property konakart.escape.chars .
`void`	`escapeCustomerRegistration(CustomerRegistrationIf custReg)` Escape the Strings in the CustomerRegistration object using the rules defined in the properties file by the property konakart.escape.chars .
`int`	`forceRegisterCustomer(CustomerRegistrationIf custReg)` A new customer is added to the system.
`Address`	`getAddress(int addressId)` Returns the address object for the given address id.
`protected Address[]`	`getAddressesPerCustomer(Customer customer)` Returns all of the addresses registered for the given customer.
`Address[]`	`getAddressesPerCustomer(java.lang.String sessionId)` Returns all of the addresses registered for the given customer.
`Address[]`	`getAddressesPerVendor(VendorIf vendor)` Returns all of the addresses registered for the given vendor.
`java.lang.String`	`getAddressFormatTemplate(int id)` Does a query on the address_format table
`CustomerGroup[]`	`getAllCustomerGroups(int languageId)` Returns an array of customer groups for all customer groups that have been defined in the system.
`CustomerGroup[]`	`getAllCustomerGroups(int languageId, java.sql.Connection con)` Returns an array of customer groups for all customer groups that have been defined in the system.
`Address`	`getCountryAndZonePerCustomer(Customer cust)` Returns the default address for the given customer.
`Address`	`getCountryAndZonePerCustomer(int customerId)` Returns the default address for the given customer.
`Address`	`getCountryAndZonePerCustomer(java.lang.String sessionId)` Returns the default address for the given customer.
`CreditCard[]`	`getCreditCardsPerCustomer(int customerId, CreditCardOptionsIf options)` Get an array of credit card objects for a logged in customer.
`CreditCard[]`	`getCreditCardsPerCustomer(java.lang.String sessionId, CreditCardOptionsIf options)` Get an array of credit card objects for a logged in customer.
`Customer`	`getCustomer(java.lang.String sessionId)` Returns the customer object for the customer defined by the given sessionId.
`Customer`	`getCustomerForEmail(java.lang.String emailAddr)` Checks to see whether a registered customer already exists with this email address.
`Customer`	`getCustomerForEmail(java.lang.String emailAddr, boolean returnNonRegisteredCustomers)` Checks to see whether a customer already exists with this email address.
`void`	`getCustomerForEmailAndSetPassword(java.lang.String emailAddr, java.lang.String password)` Get customer by email and set password
`Customer`	`getCustomerForId(int customerId)` Returns the customer object for the customer defined by the given id.
`protected Customer`	`getCustomerForNotification(NotificationOptionsIf options)` Common code
`CustomerGroup`	`getCustomerGroup(int customerGroupId, int languageId)` Returns a customer group object for the customerGroupId passed in as a parameter.
`CustomerGroup`	`getCustomerGroupFromCache(int customerGroupId)` Gets the CustomerGroup object for the customerGroupId and default language from the cache.
`CustomerGroup`	`getCustomerGroupFromCache(int customerGroupId, java.sql.Connection con)` Gets the CustomerGroup object for the customerGroupId and default language from the cache.
`Customer[]`	`getCustomers(CustomerSearch custSearch)` Retrieves an array of customers from the database that match the specified criteria in the CustomerSearch input object.
`Customer[]`	`getCustomers(CustomerSearch custSearch, java.sql.Connection con)` Retrieves an array of customers from the database that match the specified criteria in the CustomerSearch input object.
`Customer`	`getCustomerWithOptions(int customerId, FetchCustomerOptionsIf options)` Returns the customer object for the customer defined by the given customerId.
`Customer`	`getCustomerWithOptions(java.lang.String sessionId, FetchCustomerOptionsIf options)` Returns the customer object for the customer defined by the given sessionId.
`Address`	`getDefaultAddressPerCustomer(Customer cust)` Returns the default address for the given customer.
`Address`	`getDefaultAddressPerCustomer(java.lang.String sessionId)` Returns the default address for the given customer.
`Customer`	`getDefaultCustomer()` Returns the customer object for the default customer.
`java.lang.String`	`getNameFromId(int custId)`
`Product[]`	`getProductNotificationsPerCustomer(java.lang.String sessionId, int languageId)` Returns an array of products for which the customer referenced by sessionId will be notified on.
`Product[]`	`getProductNotificationsPerCustomerWithOptions(java.lang.String sessionId, int languageId, FetchProductOptionsIf options)` Returns an array of products for which the customer referenced by sessionId will be notified on.
`int`	`getTempCustomerId()` Returns an available unique temporary id.
`Vendor`	`getVendorForId(int vendorId)` Returns the vendor object for the vendor defined by the given id.
`Vendors`	`getVendors(DataDescriptorIf dataDescIn, VendorSearchIf searchIn)`
`void`	`incrementLogonCount(int customerId)` This method is not exposed to the web interface because it isn't secure.
`boolean`	`isCustomerSubscribedToNewsletter(java.lang.String emailAddr)` Regardless of the type of customer, this API call returns true if the customer referenced by the `emailAddr` parameter is subscribed to receive the newsletter.
`void`	`populateCustomerChildren(CustomerIf[] parents, boolean recursive)` Populates the child customers of the array of parent customers passed in as a parameter.
`void`	`populateCustomerChildren(CustomerIf[] parents, boolean recursive, java.sql.Connection con)` Populates the child customers of the array of parent customers passed in as a parameter.
`protected void`	`populateCustomerGroupHashMap(CustomerMgr.StaticData sd)` If the hash map is set to null or the refreshCustGroupMapFlag is set, then we populated the hash map with the customer groups in the default language.
`protected void`	`populateCustomerGroupHashMap(CustomerMgr.StaticData sd, java.sql.Connection con)` If the hash map is set to null or the refreshCustGroupMapFlag is set, then we populated the hash map with the customer groups in the default language.
`void`	`populateCustomerParents(CustomerIf[] customers)` Populates the parent customer of the customers passed in as a parameter
`void`	`populateCustomerParents(CustomerIf[] customers, java.sql.Connection con)` Populates the parent customer of the customers passed in as a parameter
`void`	`populateProductSuggestions(CustomerIf[] customers)` Populates the Product Suggestions for the customers passed in as a parameter
`void`	`refreshConfigs()` Refresh the configuration of the Customer manager
`int`	`registerCustomer(CustomerRegistrationIf custReg)` A new customer is added to the system.
`int`	`registerCustomerPrivate(CustomerRegistrationIf custReg, boolean force)` A new customer is added to the system.
`KKCriteria`	`setAllAddrAttrs(KKCriteria c)` Used by other managers to avoid repeating code.
`void`	`setCustomerEmailVerified(int customerId, boolean emailVerified)` Sets the email verified boolean attribute for the customer
`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`	`setCustomerType(int customerId, int type)` Sets the customer type.
`void`	`setDefaultAddressPerCustomer(java.lang.String sessionId, int addressId)` Sets the default address for this customer to be the addressId passed in as a parameter.
`protected void`	`updateCustomerReviews(int custId, java.sql.Connection con)` Updates a customer's reviews by setting the custId to null.
`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 boolean`	`useLocksForLogonCountIncrementer()` Utility method to return whether to use Locks for the Logon Count incrementer

Methods inherited from class com.konakart.bl.BaseMgr
acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, 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
  - CUST_TYPE_REGISTERED_CUST
```
public static final int CUST_TYPE_REGISTERED_CUST
```
    A customer that has registered normally
    
    See Also:
    
    Constant Field Values
  - CUST_TYPE_ADMIN_USER
```
public static final int CUST_TYPE_ADMIN_USER
```
    An Admin user
    
    See Also:
    
    Constant Field Values
  - CUST_TYPE_NON_REGISTERED_CUST
```
public static final int CUST_TYPE_NON_REGISTERED_CUST
```
    A customer that hasn't registered
    
    See Also:
    
    Constant Field Values
  - CUST_TYPE_DEFAULT_CUST
```
public static final int CUST_TYPE_DEFAULT_CUST
```
    Default customer
    
    See Also:
    
    Constant Field Values
  - CUST_TYPE_B2B_COMPANY_ADMIN
```
public static final int CUST_TYPE_B2B_COMPANY_ADMIN
```
    B2B Company Admin
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELETE_REVIEWS
```
protected static final boolean DEFAULT_DELETE_REVIEWS
```
    Default value for the konakart.delete_reviews property
    
    See Also:
    
    Constant Field Values
  - staticDataHM
```
protected static java.util.Map<java.lang.String,CustomerMgr.StaticData> staticDataHM
```
    Hash Map that contains the static data
  - mutex
```
protected static java.lang.String mutex
```
    mutex
  - DEFAULT_STRING
```
public static final java.lang.String DEFAULT_STRING
```
    Default value written to DB when not available
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STRING_SHORT
```
public static final java.lang.String DEFAULT_STRING_SHORT
```
    Default value written to DB when not available
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DOB
```
public static final java.util.GregorianCalendar DEFAULT_DOB
```
    Default value written to DB when not available
- Constructor Detail
  - CustomerMgr
```
public CustomerMgr(KKEngIf eng)
            throws java.lang.Exception
```
    Constructor
    
    Parameters:
    
    eng - the eng
    
    Throws:
    
    java.lang.Exception - an unexpected exception
- Method Detail
  - deleteReviews
```
protected boolean deleteReviews()
```
    Utility method to return the konakart.delete_reviews property value
    
    Returns:
    
    Value of the property value (true or false)
  - forceRegisterCustomer
```
public int forceRegisterCustomer(CustomerRegistrationIf custReg)
                          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
    If the customer already exists, we modify the registration rather than throwing an exception.
    Specified by:
    
    forceRegisterCustomer in interface CustomerMgrIf
    
    Parameters:
    
    custReg - the custReg
    
    Returns:
    
    Returns the Customer Id of the registered customer
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - registerCustomer
```
public int registerCustomer(CustomerRegistrationIf custReg)
                     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.
    Specified by:
    
    registerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    custReg - the custReg
    
    Returns:
    
    Returns the Customer Id of the registered customer
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - registerCustomerPrivate
```
public int registerCustomerPrivate(CustomerRegistrationIf 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.
    Specified by:
    
    registerCustomerPrivate in interface CustomerMgrIf
    
    Parameters:
    
    custReg - the custReg
    
    force - If set, then we modify the registration rather than throwing an exception if the customer already exists
    
    Returns:
    
    Returns the Customer Id of the registered customer
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - checkUniquenessForRegistration
```
public void checkUniquenessForRegistration(CustomerRegistrationIf 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
  - checkUniquenessForRegistration
```
public void checkUniquenessForRegistration(CustomerRegistrationIf custReg,
                                           boolean force,
                                           java.sql.Connection con)
                                    throws java.lang.Exception
```
    Check uniqueness for the username, telephone and telephone1
    
    Parameters:
    
    custReg - the custReg
    
    force - the force
    
    con - Connection for transaction
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editCustomer
```
public void editCustomer(java.lang.String sessionId,
                         CustomerIf cust)
                  throws java.lang.Exception
```
    Updates the customer data with the data in the Customer object passed in as a parameter. We also update the default address of the customer if it originally existed.
    
    Specified by:
    
    editCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    cust - the cust
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editCustomerWithOptions
```
public void editCustomerWithOptions(java.lang.String sessionId,
                                    CustomerIf cust,
                                    EditCustomerOptionsIf options)
                             throws java.lang.Exception
```
    Updates the customer data with the data in the Customer object passed in as a parameter. We also update the default address of the customer if it originally existed.
    
    Specified by:
    
    editCustomerWithOptions in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    cust - the cust
    
    options - the options
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - checkUniquenessForEdit
```
public void checkUniquenessForEdit(EditCustomerOptionsIf options,
                                   CustomerIf currentCust,
                                   CustomerIf 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
  - setCustomerPassword
```
public void setCustomerPassword(int customerId,
                                java.lang.String password)
                         throws java.lang.Exception
```
    Sets the customer password.
    
    Specified by:
    
    setCustomerPassword in interface CustomerMgrIf
    
    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 CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    password - the password
    
    forceChange - the forceChange
    
    expiry - the expiry
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - setCustomerType
```
public void setCustomerType(int customerId,
                            int type)
                     throws java.lang.Exception
```
    Sets the customer type.
    
    Specified by:
    
    setCustomerType in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    type - the type
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - useLocksForLogonCountIncrementer
```
protected boolean useLocksForLogonCountIncrementer()
```
    Utility method to return whether to use Locks for the Logon Count incrementer
    
    Returns:
    
    Returns true if we should use locks
  - incrementLogonCount
```
public void incrementLogonCount(int customerId)
                         throws org.apache.torque.TorqueException,
                                com.konakart.app.KKException,
                                com.workingdogs.village.DataSetException
```
    This method is not exposed to the web interface because it isn't secure. It increments the logon count attribute of the customers_info table.
    
    Specified by:
    
    incrementLogonCount in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getCustomers
```
public Customer[] getCustomers(CustomerSearch custSearch)
                        throws java.lang.Exception
```
    Retrieves an array of customers from the database that match the specified criteria in the CustomerSearch input object. If custId of the search object is specified (>=0) that alone is used and only one customer will be returned.
    
    Specified by:
    
    getCustomers in interface CustomerMgrIf
    
    Parameters:
    
    custSearch - CustomerSearch object
    
    Returns:
    
    Customer[] : an array of Customer Records or null if no customers are found
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomers
```
public Customer[] getCustomers(CustomerSearch custSearch,
                               java.sql.Connection con)
                        throws java.lang.Exception
```
    Retrieves an array of customers from the database that match the specified criteria in the CustomerSearch input object. If custId of the search object is specified (>=0) that alone is used and only one customer will be returned.
    
    Parameters:
    
    custSearch - CustomerSearch object
    
    con - Connection for Transaction
    
    Returns:
    
    Customer[] : an array of Customer Records or null if no customers are found
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteCustomer
```
public void 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 :
    - TABLE_REVIEWS_DESCRIPTION * see note above
    - TABLE_REVIEWS * see note above
    - TABLE_ADDRESS_BOOK
    - TABLE_CUSTOMERS
    - TABLE_CUSTOMERS_INFO
    - TABLE_CUSTOMERS_BASKET
    - TABLE_CUSTOMERS_BASKET_ATTRIBUTES
    - TABLE_WHOS_ONLINE
    Parameters :
    - custId
    Specified by:
    
    deleteCustomer in interface CustomerMgrIf
    
    Parameters:
    
    custId - the custId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - 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
  - doesCustomerExistForEmail
```
public boolean doesCustomerExistForEmail(java.lang.String emailAddr)
                                  throws org.apache.torque.TorqueException,
                                         com.konakart.app.KKException,
                                         com.workingdogs.village.DataSetException
```
    Checks to see whether a registered customer already exists with this email address.
    
    Specified by:
    
    doesCustomerExistForEmail in interface CustomerMgrIf
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    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,
                                             com.konakart.app.KKException,
                                             com.workingdogs.village.DataSetException
```
    Checks to see whether a registered customer already exists with this telephone number.
    
    Specified by:
    
    doesCustomerExistForTelephone in interface CustomerMgrIf
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    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,
                                              com.konakart.app.KKException,
                                              com.workingdogs.village.DataSetException
```
    Checks to see whether a registered customer already exists with this telephone 1 number.
    
    Specified by:
    
    doesCustomerExistForTelephone1 in interface CustomerMgrIf
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    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,
                                            com.konakart.app.KKException,
                                            com.workingdogs.village.DataSetException
```
    Checks to see whether a registered customer already exists with this username.
    
    Specified by:
    
    doesCustomerExistForUsername in interface CustomerMgrIf
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getCustomerForEmail
```
public Customer getCustomerForEmail(java.lang.String emailAddr)
                             throws java.lang.Exception
```
    Checks to see whether a registered customer already exists with this email address.
    
    Specified by:
    
    getCustomerForEmail in interface CustomerMgrIf
    
    Parameters:
    
    emailAddr - the emailAddr
    
    Returns:
    
    Returns a Customer object if the customer already exists
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerForEmailAndSetPassword
```
public void getCustomerForEmailAndSetPassword(java.lang.String emailAddr,
                                              java.lang.String password)
                                       throws java.lang.Exception
```
    Get customer by email and set password
    
    Specified by:
    
    getCustomerForEmailAndSetPassword in interface CustomerMgrIf
    
    Parameters:
    
    emailAddr - the emailAddr
    
    password - the password to set
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerForEmail
```
public Customer getCustomerForEmail(java.lang.String emailAddr,
                                    boolean returnNonRegisteredCustomers)
                             throws java.lang.Exception
```
    Checks to see whether a customer already exists with this email address.
    
    Specified by:
    
    getCustomerForEmail in interface CustomerMgrIf
    
    Parameters:
    
    emailAddr - the emailAddr
    
    returnNonRegisteredCustomers - When set, we search for non-registered customers as well as registered
    
    Returns:
    
    Returns a Customer object if the customer already exists
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doesCustomerExistForId
```
protected boolean doesCustomerExistForId(int custId)
                                  throws org.apache.torque.TorqueException,
                                         com.konakart.app.KKException
```
    Checks to see whether a customer already exists with this id
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getNameFromId
```
public java.lang.String getNameFromId(int custId)
                               throws java.lang.Exception
```
    Specified by:
    
    getNameFromId in interface CustomerMgrIf
    
    Parameters:
    
    custId - the custId
    
    Returns:
    
    Returns the customer's name
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomer
```
public Customer getCustomer(java.lang.String sessionId)
                     throws java.lang.Exception
```
    Returns the customer object for the customer defined by the given sessionId. Throws an exception if the session has expired.
    
    Specified by:
    
    getCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    Customer Object or Null if the customer doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerWithOptions
```
public Customer getCustomerWithOptions(java.lang.String sessionId,
                                       FetchCustomerOptionsIf options)
                                throws java.lang.Exception
```
    Returns the customer object for the customer defined by the given sessionId. Throws an exception if the session has expired.
    
    Specified by:
    
    getCustomerWithOptions in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    options - An object containing options for the method. It may be set to null.
    
    Returns:
    
    Customer Object or Null if the customer doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerWithOptions
```
public Customer getCustomerWithOptions(int customerId,
                                       FetchCustomerOptionsIf options)
                                throws java.lang.Exception
```
    Returns the customer object for the customer defined by the given customerId.
    
    Specified by:
    
    getCustomerWithOptions in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    options - An object containing options for the method. It may be set to null.
    
    Returns:
    
    Customer Object or Null if the customer doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerForId
```
public Customer getCustomerForId(int customerId)
                          throws java.lang.Exception
```
    Returns the customer object for the customer defined by the given id.
    
    Specified by:
    
    getCustomerForId in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    Returns:
    
    Customer Object or Null if the customer doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDefaultCustomer
```
public Customer getDefaultCustomer()
                            throws java.lang.Exception
```
    Returns the customer object for the default customer. If more than one default customer exists, it returns one of the customers found. The default customer can be configured in the Admin App. It is a fictitious customer with a real address that is used to create a temporary order even when a customer is not logged in or hasn't registered yet. The order totals of this temporary order are displayed in the cart details screen to give an indication of shipping costs and to display any available discounts.
    
    Specified by:
    
    getDefaultCustomer in interface CustomerMgrIf
    
    Returns:
    
    Customer Object or Null if the default customer doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doesCountryExist
```
protected boolean doesCountryExist(int countryId)
                            throws org.apache.torque.TorqueException,
                                   com.konakart.app.KKException
```
    Does the Country Exist?
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - doesCountryExist
```
protected boolean doesCountryExist(int countryId,
                                   java.sql.Connection con)
                            throws org.apache.torque.TorqueException,
                                   com.konakart.app.KKException
```
    Does the Country Exist?
    
    Parameters:
    
    countryId - the countryId
    
    con - Connection for transaction
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getAddressesPerCustomer
```
public Address[] getAddressesPerCustomer(java.lang.String sessionId)
                                  throws java.lang.Exception
```
    Returns all of the addresses registered for the given customer. An exception is thrown if the sessionId isn't valid.
    
    Specified by:
    
    getAddressesPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    An array of address objects where the first one is the primary address. The other addresses are ordered by descending ADDRESS_BOOK_ID. Returns an empty array if no addresses exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDefaultAddressPerCustomer
```
public Address getDefaultAddressPerCustomer(java.lang.String sessionId)
                                     throws java.lang.Exception
```
    Returns the default address for the given customer. An exception is thrown if the sessionid isn't valid.
    
    Specified by:
    
    getDefaultAddressPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    An address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDefaultAddressPerCustomer
```
public Address getDefaultAddressPerCustomer(Customer cust)
                                     throws java.lang.Exception
```
    Returns the default address for the given customer. An exception is thrown if the cust is null.
    
    Specified by:
    
    getDefaultAddressPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    cust - the cust
    
    Returns:
    
    An address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCountryAndZonePerCustomer
```
public Address getCountryAndZonePerCustomer(java.lang.String sessionId)
                                     throws java.lang.Exception
```
    Returns the default address for the given customer. An exception is thrown if the sessionid isn't valid. The default address is only populated with countryId and zoneId.
    
    Specified by:
    
    getCountryAndZonePerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    An address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCountryAndZonePerCustomer
```
public Address getCountryAndZonePerCustomer(int customerId)
                                     throws java.lang.Exception
```
    Returns the default address for the given customer. The default address is only populated with countryId and zoneId.
    
    Specified by:
    
    getCountryAndZonePerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    Returns:
    
    An address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCountryAndZonePerCustomer
```
public Address getCountryAndZonePerCustomer(Customer cust)
                                     throws java.lang.Exception
```
    Returns the default address for the given customer. The default address is only populated with countryId and zoneId.
    
    Specified by:
    
    getCountryAndZonePerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    cust - the cust
    
    Returns:
    
    An address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - setDefaultAddressPerCustomer
```
public void setDefaultAddressPerCustomer(java.lang.String sessionId,
                                         int addressId)
                                  throws java.lang.Exception
```
    Sets the default address for this customer to be the addressId passed in as a parameter. First we check that an address exists with that id and that it belongs to the customer logged in with the session id.
    
    Specified by:
    
    setDefaultAddressPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    addressId - the addressId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAddressesPerCustomer
```
protected Address[] getAddressesPerCustomer(Customer customer)
                                     throws java.lang.Exception
```
    Returns all of the addresses registered for the given customer.
    
    Parameters:
    
    customer - the customer
    
    Returns:
    
    An array of address objects where the first one is the primary address. The other addresses are ordered by descending ADDRESS_BOOK_ID. Returns an empty array if no addresses exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAddress
```
public Address getAddress(int addressId)
                   throws java.lang.Exception
```
    Returns the address object for the given address id. Returns null if it doesn't exist.
    
    Specified by:
    
    getAddress in interface CustomerMgrIf
    
    Parameters:
    
    addressId - the addressId
    
    Returns:
    
    An address object or null if it doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addAddressToCustomer
```
public int addAddressToCustomer(java.lang.String sessionId,
                                AddressIf addr)
                         throws java.lang.Exception
```
    The Address object is added to the customer defined by the SessionId. The id of the address object is ignored since it is calculated during the insertion process. The zoneId is also calculated unless addr.isUseZoneId()is set to true. In this case the zoneId from the address object is used. The customerId of the address object is also ignored. An exception is thrown if the sessionId isn't valid.
    
    Specified by:
    
    addAddressToCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    addr - the addr
    
    Returns:
    
    Id of the new address object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteAddressFromCustomer
```
public void deleteAddressFromCustomer(java.lang.String sessionId,
                                      int addressId)
                               throws java.lang.Exception
```
    The address defined by customerId and addressId is deleted. The customerId is retrieved from the session. An exception is thrown if the session isn't valid or we are trying to delete the default address.
    
    Specified by:
    
    deleteAddressFromCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    addressId - the addressId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editCustomerAddress
```
public void editCustomerAddress(java.lang.String sessionId,
                                AddressIf addr)
                         throws java.lang.Exception
```
    The Address object will replace the existing address object in the database with the same id. A check is made to verify that the address object belongs to the customer logged in with the sessionId passed in as a parameter. The zoneId is ignored since it is calculated during the insertion process, unless addr.isUseZoneId()is set to true. In this case the zoneId from the address object is used. The addressId is used to identify the address object. The customerId of the address object is ignored since it is obtained from the sessionId. An exception is thrown if the session isn't valid.
    
    Specified by:
    
    editCustomerAddress in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    addr - the addr
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - setAllAddrAttrs
```
public KKCriteria setAllAddrAttrs(KKCriteria c)
```
    Description copied from interface: CustomerMgrIf
    
    Used by other managers to avoid repeating code. It returns the criteria object with all address attributes set.
    
    Specified by:
    
    setAllAddrAttrs in interface CustomerMgrIf
    
    Parameters:
    
    c - the c
    
    Returns:
    
    The criteria object with all address attributes set
  - getAddressFormatTemplate
```
public java.lang.String getAddressFormatTemplate(int id)
                                          throws org.apache.torque.TorqueException,
                                                 com.workingdogs.village.DataSetException,
                                                 com.konakart.app.KKException
```
    Does a query on the address_format table
    
    Specified by:
    
    getAddressFormatTemplate in interface CustomerMgrIf
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - addCustomerNotifications
```
public void addCustomerNotifications(NotificationOptionsIf options)
                              throws java.lang.Exception
```
    A method that allows you sign up a customer for a newsletter or product notification. The customer may be registered or non registered. The parameters are contained within the NotificationOptions object and function as follows:
    1. If sessionId is not null, it will be checked and the identity of the customer will be retrieved from the sessionId.
    2. If customerId is set to a positive value, it will be used to identify the customer. If the id is that of a registered customer, then a KKUserExistsException is thrown. In this case the user must be logged in and the sessionId parameter must be set to a valid value.
    3. If emailAddr is not null then it is used to sign up the customer. If the email address belongs to a registered customer, then a KKUserExistsException is thrown. In this case the user must be logged in and the sessionId parameter must be set to a valid value.
    Note that the above parameters are exclusive and will be processed in the order displayed.
    Specified by:
    
    addCustomerNotifications in interface CustomerMgrIf
    
    Parameters:
    
    options - the options
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteCustomerNotifications
```
public void deleteCustomerNotifications(NotificationOptionsIf options)
                                 throws java.lang.Exception
```
    A method that allows you remove a customer notification for a newsletter or product. The customer may be registered or non registered. The parameters are contained within the NotificationOptions object and function as follows:
    1. If sessionId is not null, it will be checked and the identity of the customer will be retrieved from the sessionId.
    2. If customerId is set to a positive value, it will be used to identify the customer. If the id is that of a registered customer, then a KKUserExistsException is thrown. In this case the user must be logged in and the sessionId parameter must be set to a valid value.
    3. If emailAddr is not null then it is used to identify the customer. If the email address belongs to a registered customer, then a KKUserExistsException is thrown. In this case the user must be logged in and the sessionId parameter must be set to a valid value.
    Note that the above parameters are exclusive and will be processed in the order displayed.
    Specified by:
    
    deleteCustomerNotifications in interface CustomerMgrIf
    
    Parameters:
    
    options - the options
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - isCustomerSubscribedToNewsletter
```
public boolean isCustomerSubscribedToNewsletter(java.lang.String emailAddr)
                                         throws java.lang.Exception
```
    Regardless of the type of customer, this API call returns true if the customer referenced by the emailAddr parameter is subscribed to receive the newsletter.
    
    Specified by:
    
    isCustomerSubscribedToNewsletter in interface CustomerMgrIf
    
    Parameters:
    
    emailAddr - the emailAddr
    
    Returns:
    
    Returns true if the customer is subscribed
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerForNotification
```
protected Customer getCustomerForNotification(NotificationOptionsIf options)
                                       throws java.lang.Exception
```
    Common code
    
    Parameters:
    
    options - the options
    
    Returns:
    
    Returns a customer object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addProductNotificationToCustomer
```
public void addProductNotificationToCustomer(java.lang.String sessionId,
                                             int productId)
                                      throws java.lang.Exception
```
    Description copied from interface: CustomerMgrIf
    
    Adds a product notification to the customer referenced by the session id
    
    Specified by:
    
    addProductNotificationToCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addProductNotificationToCustomer
```
protected void addProductNotificationToCustomer(int customerId,
                                                int productId)
                                         throws java.lang.Exception
```
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteProductNotificationFromCustomer
```
public void deleteProductNotificationFromCustomer(java.lang.String sessionId,
                                                  int productId)
                                           throws java.lang.Exception
```
    Description copied from interface: CustomerMgrIf
    
    Deletes a product notification from the customer referenced by the session id
    
    Specified by:
    
    deleteProductNotificationFromCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteProductNotificationFromCustomer
```
public void deleteProductNotificationFromCustomer(int customerId,
                                                  int productId)
                                           throws java.lang.Exception
```
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductNotificationsPerCustomer
```
public Product[] getProductNotificationsPerCustomer(java.lang.String sessionId,
                                                    int languageId)
                                             throws java.lang.Exception
```
    Description copied from interface: CustomerMgrIf
    
    Returns an array of products for which the customer referenced by sessionId will be notified on.
    
    Specified by:
    
    getProductNotificationsPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductNotificationsPerCustomerWithOptions
```
public Product[] getProductNotificationsPerCustomerWithOptions(java.lang.String sessionId,
                                                               int languageId,
                                                               FetchProductOptionsIf options)
                                                        throws java.lang.Exception
```
    Description copied from interface: CustomerMgrIf
    
    Returns an array of products for which the customer referenced by sessionId will be notified on. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductNotificationsPerCustomerWithOptions in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doesZoneExist
```
public 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.
    
    Specified by:
    
    doesZoneExist in interface CustomerMgrIf
    
    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
  - doesZoneExist
```
public boolean doesZoneExist(java.lang.String zoneDesc,
                             int countryId,
                             java.sql.Connection con)
                      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
    
    con - Connection for transaction
    
    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
  - getTempCustomerId
```
public int getTempCustomerId()
                      throws org.apache.torque.TorqueException,
                             com.konakart.app.KKException
```
    Description copied from interface: CustomerMgrIf
    
    Returns an available unique temporary id.
    
    Specified by:
    
    getTempCustomerId in interface CustomerMgrIf
    
    Returns:
    
    The latest temporaryId
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getAllCustomerGroups
```
public CustomerGroup[] getAllCustomerGroups(int languageId)
                                     throws java.lang.Exception
```
    Returns an array of customer groups for all customer groups that have been defined in the system. The groups returned are those for the language defined by languageId.
    
    Specified by:
    
    getAllCustomerGroups in interface CustomerMgrIf
    
    Parameters:
    
    languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
    
    Returns:
    
    An array of customer group objects.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllCustomerGroups
```
public CustomerGroup[] getAllCustomerGroups(int languageId,
                                            java.sql.Connection con)
                                     throws java.lang.Exception
```
    Returns an array of customer groups for all customer groups that have been defined in the system. The groups returned are those for the language defined by languageId.
    
    Parameters:
    
    languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
    
    con - Connection for transaction
    
    Returns:
    
    An array of customer group objects.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerGroup
```
public CustomerGroup getCustomerGroup(int customerGroupId,
                                      int languageId)
                               throws java.lang.Exception
```
    Returns a customer group object for the customerGroupId passed in as a parameter.
    
    Specified by:
    
    getCustomerGroup in interface CustomerMgrIf
    
    Parameters:
    
    customerGroupId - the customerGroupId
    
    languageId - The id for the language that will be used to determine the customer group name and description. Value of -1 selects the default language.
    
    Returns:
    
    A customer group object.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerGroupFromCache
```
public CustomerGroup getCustomerGroupFromCache(int customerGroupId)
                                        throws java.lang.Exception
```
    Gets the CustomerGroup object for the customerGroupId and default language from the cache.
    
    Specified by:
    
    getCustomerGroupFromCache in interface CustomerMgrIf
    
    Parameters:
    
    customerGroupId - the customerGroupId
    
    Returns:
    
    Returns a CustomerGroup object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomerGroupFromCache
```
public CustomerGroup getCustomerGroupFromCache(int customerGroupId,
                                               java.sql.Connection con)
                                        throws java.lang.Exception
```
    Gets the CustomerGroup object for the customerGroupId and default language from the cache.
    
    Parameters:
    
    customerGroupId - the customerGroupId
    
    con - Connection for transaction
    
    Returns:
    
    Returns a CustomerGroup object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - populateCustomerGroupHashMap
```
protected void populateCustomerGroupHashMap(CustomerMgr.StaticData sd)
                                     throws java.lang.Exception
```
    If the hash map is set to null or the refreshCustGroupMapFlag is set, then we populated the hash map with the customer groups in the default language. Otherwise we just return.
    
    Parameters:
    
    sd - the sd
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - populateCustomerGroupHashMap
```
protected void populateCustomerGroupHashMap(CustomerMgr.StaticData sd,
                                            java.sql.Connection con)
                                     throws java.lang.Exception
```
    If the hash map is set to null or the refreshCustGroupMapFlag is set, then we populated the hash map with the customer groups in the default language. Otherwise we just return.
    
    Parameters:
    
    sd - the sd
    
    con - Connection for transaction
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - refreshConfigs
```
public void refreshConfigs()
                    throws com.konakart.app.KKException
```
    Refresh the configuration of the Customer manager
    
    Specified by:
    
    refreshConfigs in interface CustomerMgrIf
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - enableCustomer
```
public void enableCustomer(int customerId)
                    throws com.konakart.app.KKException,
                           org.apache.torque.TorqueException
```
    Enables the customer identified by the customer id. If the customer doesn't exist then an exception is thrown.
    
    Specified by:
    
    enableCustomer in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - setCustomerEmailVerified
```
public void setCustomerEmailVerified(int customerId,
                                     boolean emailVerified)
                              throws com.konakart.app.KKException,
                                     org.apache.torque.TorqueException
```
    Sets the email verified boolean attribute for the customer
    
    Specified by:
    
    setCustomerEmailVerified in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    emailVerified - the emailVerified
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - populateCustomerChildren
```
public void populateCustomerChildren(CustomerIf[] 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
  - populateCustomerChildren
```
public void populateCustomerChildren(CustomerIf[] parents,
                                     boolean recursive,
                                     java.sql.Connection con)
                              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.
    
    con - Connection for transaction
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - populateProductSuggestions
```
public void populateProductSuggestions(CustomerIf[] customers)
                                throws java.lang.Exception
```
    Populates the Product Suggestions for the customers passed in as a parameter
    
    Specified by:
    
    populateProductSuggestions in interface CustomerMgrIf
    
    Parameters:
    
    customers - An array of customers
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - populateCustomerParents
```
public void populateCustomerParents(CustomerIf[] 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
  - populateCustomerParents
```
public void populateCustomerParents(CustomerIf[] customers,
                                    java.sql.Connection con)
                             throws java.lang.Exception
```
    Populates the parent customer of the customers passed in as a parameter
    
    Parameters:
    
    customers - An array of customers
    
    con - Connection for transaction
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addCreditCardToCustomer
```
public int addCreditCardToCustomer(CreditCardIf card,
                                   CreditCardOptionsIf options)
                            throws java.lang.Exception
```
    Inserts a CreditCard object into the database. The object must be associated with an existing customer through the customer id attribute. If the address id attribute contains an id of an address object, that address must belong to the customer defined by customer id.
    
    Specified by:
    
    addCreditCardToCustomer in interface CustomerMgrIf
    
    Parameters:
    
    card - A Credit Card object
    
    options - Options not currently used
    
    Returns:
    
    Returns the id of the inserted object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addCreditCardToCustomer
```
public int addCreditCardToCustomer(java.lang.String sessionId,
                                   CreditCardIf card,
                                   CreditCardOptionsIf options)
                            throws java.lang.Exception
```
    Inserts a CreditCard object into the database. The customer must be logged in with a valid session id. The id of the logged in customer is written into the customerId attribute of the CreditCard object before it is saved.
    
    Specified by:
    
    addCreditCardToCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    card - A CreditCard object
    
    options - Options not currently used
    
    Returns:
    
    Returns the id of the inserted object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCreditCardsPerCustomer
```
public CreditCard[] getCreditCardsPerCustomer(java.lang.String sessionId,
                                              CreditCardOptionsIf options)
                                       throws java.lang.Exception
```
    Get an array of credit card objects for a logged in customer. An empty array is returned if there are no cards.
    
    Specified by:
    
    getCreditCardsPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    options - Used to manage whether the returned cards have the formatted address attribute populated
    
    Returns:
    
    Returns an array of credit card objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCreditCardsPerCustomer
```
public CreditCard[] getCreditCardsPerCustomer(int customerId,
                                              CreditCardOptionsIf options)
                                       throws java.lang.Exception
```
    Get an array of credit card objects for a logged in customer. An empty array is returned if there are no cards.
    
    Specified by:
    
    getCreditCardsPerCustomer in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    options - Used to manage whether the returned cards have the formatted address attribute populated
    
    Returns:
    
    Returns an array of credit card objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteCreditCard
```
public void deleteCreditCard(java.lang.String sessionId,
                             int cardId)
                      throws java.lang.Exception
```
    Deletes the credit card referenced by cardId that must belong to the logged in customer.
    
    Specified by:
    
    deleteCreditCard in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    cardId - the cardId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteCreditCard
```
public void deleteCreditCard(int customerId,
                             int cardId)
                      throws java.lang.Exception
```
    Deletes the credit card referenced by cardId that must belong to the customer with id customerId
    
    Specified by:
    
    deleteCreditCard in interface CustomerMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    cardId - the cardId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editCreditCard
```
public void editCreditCard(java.lang.String sessionId,
                           CreditCardIf card,
                           CreditCardOptionsIf options)
                    throws java.lang.Exception
```
    Edit the credit card of a logged in customer referenced by sessionId. The existing card must belong to this customer.
    
    Specified by:
    
    editCreditCard in interface CustomerMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    card - A credit card object
    
    options - Options not currently used
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - escapeCustomerRegistration
```
public void escapeCustomerRegistration(CustomerRegistrationIf custReg)
```
    Escape the Strings in the CustomerRegistration object using the rules defined in the properties file by the property konakart.escape.chars . This method may be overridden in a custom manager to add exceptions for attributes that don't need to be escaped or to disable the escaping completely.
    
    Specified by:
    
    escapeCustomerRegistration in interface CustomerMgrIf
    
    Parameters:
    
    custReg - the custReg
  - escapeAddress
```
public void escapeAddress(AddressIf addr)
```
    Escape the Strings in the Address object using the rules defined in the properties file by the property konakart.escape.chars . This method may be overridden in a custom manager to add exceptions for attributes that don't need to be escaped or to disable the escaping completely.
    
    Specified by:
    
    escapeAddress in interface CustomerMgrIf
    
    Parameters:
    
    addr - the addr
  - escapeCustomer
```
public void escapeCustomer(CustomerIf cust)
```
    Escape the Strings in the Customer object using the rules defined in the properties file by the property konakart.escape.chars . This method may be overridden in a custom manager to add exceptions for attributes that don't need to be escaped or to disable the escaping completely.
    
    Specified by:
    
    escapeCustomer in interface CustomerMgrIf
    
    Parameters:
    
    cust - the cust
  - doesVendorExist
```
public boolean doesVendorExist(int vendorId)
                        throws org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException,
                               com.konakart.app.KKException
```
    Figure out whether a vendor exists
    
    Specified by:
    
    doesVendorExist in interface CustomerMgrIf
    
    Parameters:
    
    vendorId - the vendorId
    
    Returns:
    
    Returns true if the vendor exists
    
    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)
    
    com.konakart.app.KKException - an unexpected KKException 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 CustomerMgrIf
    
    Parameters:
    
    vendorId - the vendorId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAddressesPerVendor
```
public Address[] getAddressesPerVendor(VendorIf vendor)
                                throws java.lang.Exception
```
    Returns all of the addresses registered for the given vendor.
    
    Specified by:
    
    getAddressesPerVendor in interface CustomerMgrIf
    
    Parameters:
    
    vendor - the vendor
    
    Returns:
    
    An array of address objects where the first one is the primary address. The other addresses are ordered by descending ADDRESS_BOOK_ID. Returns an empty array if no addresses exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getVendors
```
public Vendors getVendors(DataDescriptorIf dataDescIn,
                          VendorSearchIf searchIn)
                   throws java.lang.Exception
```
    Specified by:
    
    getVendors in interface CustomerMgrIf
    
    Parameters:
    
    dataDescIn - the dataDescIn
    
    searchIn - the searchIn
    
    Returns:
    
    Returns a Vendors object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getVendorForId
```
public Vendor getVendorForId(int vendorId)
                      throws java.lang.Exception
```
    Returns the vendor object for the vendor defined by the given id.
    
    Specified by:
    
    getVendorForId in interface CustomerMgrIf
    
    Parameters:
    
    vendorId - the vendorId
    
    Returns:
    
    Vendor Object or Null if the vendor doesn't exist.
    
    Throws:
    
    java.lang.Exception - an unexpected exception

Class CustomerMgr

Nested Class Summary

Field Summary

Fields inherited from class com.konakart.bl.BaseMgr

Constructor Summary

Method Summary

Methods inherited from class com.konakart.bl.BaseMgr

Methods inherited from class java.lang.Object

Field Detail

log

CUST_TYPE_REGISTERED_CUST

CUST_TYPE_ADMIN_USER

CUST_TYPE_NON_REGISTERED_CUST

CUST_TYPE_DEFAULT_CUST

CUST_TYPE_B2B_COMPANY_ADMIN

DEFAULT_DELETE_REVIEWS

staticDataHM

mutex

DEFAULT_STRING

DEFAULT_STRING_SHORT

DEFAULT_DOB

Constructor Detail

CustomerMgr

Method Detail

deleteReviews

forceRegisterCustomer

registerCustomer

registerCustomerPrivate

checkUniquenessForRegistration

checkUniquenessForRegistration

editCustomer

editCustomerWithOptions

checkUniquenessForEdit

setCustomerPassword

setCustomerPassword

setCustomerType

useLocksForLogonCountIncrementer

incrementLogonCount

getCustomers

getCustomers

deleteCustomer

deleteCustomerReviews

updateCustomerReviews

doesCustomerExistForEmail

doesCustomerExistForTelephone

doesCustomerExistForTelephone1

doesCustomerExistForUsername

getCustomerForEmail

getCustomerForEmailAndSetPassword

getCustomerForEmail

doesCustomerExistForId

getNameFromId

getCustomer

getCustomerWithOptions

getCustomerWithOptions

getCustomerForId

getDefaultCustomer

doesCountryExist

doesCountryExist

getAddressesPerCustomer

getDefaultAddressPerCustomer

getDefaultAddressPerCustomer

getCountryAndZonePerCustomer

getCountryAndZonePerCustomer

getCountryAndZonePerCustomer

setDefaultAddressPerCustomer

getAddressesPerCustomer

getAddress

addAddressToCustomer

deleteAddressFromCustomer

editCustomerAddress

setAllAddrAttrs

getAddressFormatTemplate

addCustomerNotifications

deleteCustomerNotifications

isCustomerSubscribedToNewsletter

getCustomerForNotification

addProductNotificationToCustomer

addProductNotificationToCustomer

deleteProductNotificationFromCustomer