com.konakart.blif

Interface CustomerMgrIf

All Known Implementing Classes:

CustomerMgr, CustomerMgrEE, CustomerMgrWond

public interface CustomerMgrIf

CustomerMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

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.
void	addProductNotificationToCustomer(java.lang.String sessionId, int productId) Adds a product notification to the customer referenced by the session id
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.
void	deleteProductNotificationFromCustomer(java.lang.String sessionId, int productId) Deletes a product notification from the customer referenced by the session id
boolean	doesCustomerExistForEmail(java.lang.String emailAddr) Checks to see whether a customer already exists with this email address.
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.
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.
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.
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.
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.
Customer[]	getCustomers(CustomerSearch custSearch) 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	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.
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.

Method Detail

forceRegisterCustomer

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.

Parameters:

custReg - the custReg

Returns:

Returns the Customer Id of the registered customer

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

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.

Parameters:

custReg - the custReg

Returns:

Returns the Customer Id of the registered customer

Throws:

java.lang.Exception - an unexpected exception

registerCustomerPrivate

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.

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

deleteCustomer

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

Parameters:

custId - the custId

Throws:

java.lang.Exception - an unexpected exception

editCustomer

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.

Parameters:

sessionId - the sessionId

cust - the cust

Throws:

java.lang.Exception - an unexpected exception

editCustomerWithOptions

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.

Parameters:

sessionId - the sessionId

cust - the cust

options - the options

Throws:

java.lang.Exception - an unexpected exception

setCustomerPassword

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

Sets the customer password.

Parameters:

customerId - the customerId

password - the password

Throws:

java.lang.Exception - an unexpected exception

setCustomerPassword

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

Parameters:

customerId - the customerId

password - the password

forceChange - the forceChange

expiry - the expiry

Throws:

java.lang.Exception - an unexpected exception

setCustomerType

void setCustomerType(int customerId,
                     int type)
              throws java.lang.Exception

Sets the customer type.

Parameters:

customerId - the customerId

type - the type

Throws:

java.lang.Exception - an unexpected exception

incrementLogonCount

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.

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)

doesCustomerExistForEmail

boolean doesCustomerExistForEmail(java.lang.String emailAddr)
                           throws org.apache.torque.TorqueException,
                                  com.konakart.app.KKException,
                                  com.workingdogs.village.DataSetException

Checks to see whether a customer already exists with this email address. If a customer does exist, but it is a non registered customer then we act as if no customer exists.

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)

getCustomerForEmail

Customer getCustomerForEmail(java.lang.String emailAddr)
                      throws java.lang.Exception

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

Parameters:

emailAddr - the emailAddr

Returns:

Returns a Customer object if the customer already exists

Throws:

java.lang.Exception - an unexpected exception

getCustomerForEmailAndSetPassword

void getCustomerForEmailAndSetPassword(java.lang.String emailAddr,
                                       java.lang.String password)
                                throws java.lang.Exception

Get customer by email and set password

Parameters:

emailAddr - the emailAddr

password - the password to set

Throws:

java.lang.Exception - an unexpected exception

getCustomerForEmail

Customer getCustomerForEmail(java.lang.String emailAddr,
                             boolean returnNonRegisteredCustomers)
                      throws java.lang.Exception

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

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

getNameFromId

java.lang.String getNameFromId(int custId)
                        throws java.lang.Exception

Parameters:

custId - the custId

Returns:

Returns the customer's name

Throws:

java.lang.Exception - an unexpected exception

getCustomer

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.

Parameters:

sessionId - the sessionId

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getCustomerWithOptions

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.

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

Customer getCustomerWithOptions(int customerId,
                                FetchCustomerOptionsIf options)
                         throws java.lang.Exception

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

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

Customer getCustomerForId(int customerId)
                   throws java.lang.Exception

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

Parameters:

customerId - the customerId

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getDefaultCustomer

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.

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getAddressesPerCustomer

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.

Parameters:

sessionId - the sessionId

Returns:

An array of address objects where the first one is the primary address. Returns an empty array if no addresses exist.

Throws:

java.lang.Exception - an unexpected exception

getDefaultAddressPerCustomer

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.

Parameters:

sessionId - the sessionId

Returns:

An address object

Throws:

java.lang.Exception - an unexpected exception

getDefaultAddressPerCustomer

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.

Parameters:

cust - the cust

Returns:

An address object

Throws:

java.lang.Exception - an unexpected exception

getCountryAndZonePerCustomer

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.

Parameters:

sessionId - the sessionId

Returns:

An address object

Throws:

java.lang.Exception - an unexpected exception

getCountryAndZonePerCustomer

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.

Parameters:

customerId - the customerId

Returns:

An address object

Throws:

java.lang.Exception - an unexpected exception

getCountryAndZonePerCustomer

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.

Parameters:

cust - the cust

Returns:

An address object

Throws:

java.lang.Exception - an unexpected exception

setDefaultAddressPerCustomer

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.

Parameters:

sessionId - the sessionId

addressId - the addressId

Throws:

java.lang.Exception - an unexpected exception

addAddressToCustomer

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.

Parameters:

sessionId - the sessionId

addr - the addr

Returns:

Id of the new address object

Throws:

java.lang.Exception - an unexpected exception

deleteAddressFromCustomer

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.

Parameters:

sessionId - the sessionId

addressId - the addressId

Throws:

java.lang.Exception - an unexpected exception

editCustomerAddress

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.

Parameters:

sessionId - the sessionId

addr - the addr

Throws:

java.lang.Exception - an unexpected exception

getAddressFormatTemplate

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

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

addProductNotificationToCustomer

void addProductNotificationToCustomer(java.lang.String sessionId,
                                      int productId)
                               throws java.lang.Exception

Adds a product notification to the customer referenced by the session id

Parameters:

sessionId - the sessionId

productId - the productId

Throws:

java.lang.Exception - an unexpected exception

deleteProductNotificationFromCustomer

void deleteProductNotificationFromCustomer(java.lang.String sessionId,
                                           int productId)
                                    throws java.lang.Exception

Deletes a product notification from the customer referenced by the session id

Parameters:

sessionId - the sessionId

productId - the productId

Throws:

java.lang.Exception - an unexpected exception

getProductNotificationsPerCustomer

Product[] getProductNotificationsPerCustomer(java.lang.String sessionId,
                                             int languageId)
                                      throws java.lang.Exception

Returns an array of products for which the customer referenced by sessionId will be notified on.

Parameters:

sessionId - the sessionId

languageId - the languageId

Returns:

Array of products

Throws:

java.lang.Exception - an unexpected exception

getProductNotificationsPerCustomerWithOptions

Product[] getProductNotificationsPerCustomerWithOptions(java.lang.String sessionId,
                                                        int languageId,
                                                        FetchProductOptionsIf options)
                                                 throws java.lang.Exception

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.

Parameters:

sessionId - the sessionId

languageId - the languageId

options - the options

Returns:

Array of products

Throws:

java.lang.Exception - an unexpected exception

getTempCustomerId

int getTempCustomerId()
               throws org.apache.torque.TorqueException,
                      com.konakart.app.KKException

Returns an available unique temporary id.

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

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.

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

getCustomerGroup

CustomerGroup getCustomerGroup(int customerGroupId,
                               int languageId)
                        throws java.lang.Exception

Returns a customer group object for the customerGroupId passed in as a parameter.

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

CustomerGroup getCustomerGroupFromCache(int customerGroupId)
                                 throws java.lang.Exception

Gets the CustomerGroup object for the customerGroupId and default language from the cache.

Parameters:

customerGroupId - the customerGroupId

Returns:

Returns a CustomerGroup object

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

void refreshConfigs()
             throws com.konakart.app.KKException

Refresh the configuration of the Customer manager

Throws:

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

getAddress

Address getAddress(int addressId)
            throws java.lang.Exception

Returns the address object for the given address id. Returns null if it doesn't exist.

Parameters:

addressId - the addressId

Returns:

An address object or null if it doesn't exist.

Throws:

java.lang.Exception - an unexpected exception

setAllAddrAttrs

KKCriteria setAllAddrAttrs(KKCriteria c)

Used by other managers to avoid repeating code. It returns the criteria object with all address attributes set.

Parameters:

c - the c

Returns:

Returns the criteria object with all address attributes set

enableCustomer

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.

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

addCustomerNotifications

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.

Parameters:

options - the options

Throws:

java.lang.Exception - an unexpected exception

deleteCustomerNotifications

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.

Parameters:

options - the options

Throws:

java.lang.Exception - an unexpected exception

getCustomers

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.

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

setCustomerEmailVerified

void setCustomerEmailVerified(int customerId,
                              boolean emailVerified)
                       throws com.konakart.app.KKException,
                              org.apache.torque.TorqueException

Sets the email verified boolean attribute for the customer

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)

addCreditCardToCustomer

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.

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

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.

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

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.

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

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.

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

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.

Parameters:

sessionId - the sessionId

cardId - the cardId

Throws:

java.lang.Exception - an unexpected exception

deleteCreditCard

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

Parameters:

customerId - the customerId

cardId - the cardId

Throws:

java.lang.Exception - an unexpected exception

editCreditCard

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.

Parameters:

sessionId - the sessionId

card - A credit card object

options - Options not currently used

Throws:

java.lang.Exception - an unexpected exception

doesZoneExist

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

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

Parameters:

zoneDesc - the zoneDesc

countryId - the countryId

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

doesCustomerExistForTelephone

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.

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

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.

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

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.

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)

escapeCustomerRegistration

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.

Parameters:

custReg - the custReg

escapeAddress

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.

Parameters:

addr - the addr

escapeCustomer

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.

Parameters:

cust - the cust

doesVendorExist

boolean doesVendorExist(int vendorId)
                 throws org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException,
                        com.konakart.app.KKException

Figure out whether a vendor exists

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

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.

Parameters:

vendorId - the vendorId

Throws:

java.lang.Exception - an unexpected exception

getAddressesPerVendor

Address[] getAddressesPerVendor(VendorIf vendor)
                         throws java.lang.Exception

Returns all of the addresses registered for the given vendor.

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

Vendors getVendors(DataDescriptorIf dataDescIn,
                   VendorSearchIf searchIn)
            throws java.lang.Exception

Parameters:

dataDescIn - the dataDescIn

searchIn - the searchIn

Returns:

Returns a Vendors object

Throws:

java.lang.Exception - an unexpected exception

getVendorForId

Vendor getVendorForId(int vendorId)
               throws java.lang.Exception

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

Parameters:

vendorId - the vendorId

Returns:

Vendor Object or Null if the vendor doesn't exist.

Throws:

java.lang.Exception - an unexpected exception

isCustomerSubscribedToNewsletter

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.

Parameters:

emailAddr - the emailAddr

Returns:

Returns true if the customer is subscribed

Throws:

java.lang.Exception - an unexpected exception

populateProductSuggestions

void populateProductSuggestions(CustomerIf[] customers)
                         throws java.lang.Exception

Populates the Product Suggestions for the customers passed in as a parameter

Parameters:

customers - An array of customers

Throws:

java.lang.Exception - an unexpected exception