com.konakartadmin.blif

Interface AdminCustomerMgrIf

All Known Implementing Classes:

AdminCustomerMgr, AdminCustomerMgrEE

public interface AdminCustomerMgrIf

AdminCustomerMgrIf

Method Summary

Modifier and Type	Method and Description
void	addChildrenToCustomer(int parentId, AdminCustomer[] children) The array of AdminCustomer children objects are given the parent id passed in as a parameter.
void	addVendorToStore(int vendorId, java.lang.String vendorStoreId) Associates a vendor with a store
AdminCloneCustomerResult	cloneCustomer(int superUserId, int cloneCustId, java.lang.String[] stores) This API call is used to clone customers across multiple stores and is only available when in multi-store single DB, non shared customer mode.
void	createMailingList(AdminCustomerSearch search, AdminMailListOptions listOptions) Create a mailing list file on disk that contains a record for every customer defined by the AdminCustomerSearch object.
int	deleteCustomer(int custId) Deletes a customer from the database.
int	deleteCustomerGroup(int custGroupId) Delete a Customer Group.
AdminDeleteCustomerResult	deleteCustomerMultiStore(int superUserId, int customerId, java.lang.String[] stores) This API call is used to delete customers across multiple stores and is only available when in multi-store single DB, non shared customer mode.
void	deleteProductNotification(int custId, int prodId) Delete a Product Notification record for the specified customer and product if it's found.
void	deleteVendor(int vendorId) Delete a vendor
boolean	doesCustomerExistForEmail(java.lang.String emailAddr) Checks to see whether a customer already exists with this email address.
boolean	doesCustomerExistForId(int custId) Checks to see whether a customer already exists with this id
boolean	doesCustomerExistForTelephone(java.lang.String telephone) Checks to see whether a registered customer already exists with this telephone number.
boolean	doesCustomerExistForTelephone1(java.lang.String telephone1) Checks to see whether a registered customer already exists with this telephone 1 number.
boolean	doesCustomerExistForUsername(java.lang.String username) Checks to see whether a registered customer already exists with this username.
int	forceRegisterCustomer(AdminCustomerRegistration custReg) A new customer is added to the system.
java.lang.String	getAddressFormatTemplate(int id) Does a query on the address_format table
AdminAddressFormat[]	getAllAddressFormats() This returns an array of all the address formats
AdminCustomer	getCustomerForEmail(java.lang.String emailAddr) Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.
AdminCustomer	getCustomerForEmailWithOptions(java.lang.String emailAddr, AdminGetCustomerOptions options) Checks to see whether a customer already exists with this email address and returns the customer object if it does exist.
AdminCustomer	getCustomerForId(int customerId) Returns the customer object for the customer defined by the given id.
AdminCustomer	getCustomerForIdWithOptions(int customerId, AdminGetCustomerOptions options) Returns the customer object for the customer defined by the given id.
AdminCustomerGroupSearchResult	getCustomerGroups(AdminCustomerGroupSearch search) This returns an AdminCustomerGroupSearchResult object.
AdminCustomerGroup[]	getCustomerGroupsPerPromotion(int promotionId, int languageId) Returns all of the customer groups for the promotion
int	getCustomerIdForEmail(java.lang.String emailAddr) Finds the custId of the specified customer.
AdminCustomerSearchResult	getCustomers(AdminCustomerSearch custSearch, int offset, int size) Returns a set of Customers that match the search criteria
int	getCustomersCount(AdminCustomerSearch search) Returns a count of the number of Customers
AdminCustomerSearchResult	getCustomersLite(AdminCustomerSearch custSearch, int offset, int size) Returns a set of "Lite" Customers that match the search criteria.
java.lang.String	getDbPassword(int userId) Get the password from the database for the given userId
AdminProductNotification[]	getProductNotificationsForCustomer(int customerId) Get an array of product notifications for the customer
java.lang.String	getRandomPassword(int length) Get a random password for a Customer.
AdminStore[]	getStoresForCustomer(int superUserId, java.lang.String emailAddress) This API call is only available when in multi-store single DB, non shared customer mode.
AdminVendor	getVendorForId(int vendorId) Return a vendor for the numeric vendorId
AdminVendorSearchResult	getVendors(AdminVendorSearch vendorSearch, int offset, int size) Returns a set of Vendors that match the search criteria
void	incrementLogonCount(int customerId) This method increments the logon count attribute of the customers_info table and sets the last logged in date for the customer.
int	insertCustomerGroup(AdminCustomerGroup custGroup) Insert a customer group
int	insertCustomerGroups(AdminCustomerGroup[] custGroups) Insert an array of AdminCustomerGroup objects.
void	insertProductNotification(int custId, int prodId) Insert a Product Notification record for the specified customer and product.
int	insertVendor(AdminVendor vendor) Insert a vendor
void	refreshConfigs() Refresh the configuration of the Admin Customer Manager
int	registerCustomer(AdminCustomerRegistration custReg) A new customer is added to the system.
void	resetCustomerPassword(int custId) Reset a customer's password.
void	resetCustomerPasswordSpecifyingEmail(int custId, java.lang.String eMailAddress) Reset a customer's password using the eMail address specified.
void	sendTemplateEmailToCustomers(AdminCustomerSearch custSearch, java.lang.String templateName, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3, java.lang.Object obj4, java.lang.Object obj5, int numberEmailThreads) Calls sendTemplateEmailToCustomersWithOptions() with null options.
void	sendTemplateEmailToCustomersWithOptions(AdminCustomerSearch custSearch, java.lang.String templateName, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3, java.lang.Object obj4, java.lang.Object obj5, int numberEmailThreads, AdminEmailOptions options) An email is sent to the customer.
void	setCustomerPassword(int customerId, java.lang.String password) Sets the customer password.
void	setCustomerPassword(int customerId, java.lang.String password, boolean forceChange, java.util.Calendar expiry) Set the customer password as well as the expiry date and whether the customer should be forced to change it
void	updateCustomer(AdminCustomer cust) We must update the following tables: customers, address_book (for the default address) and customers_info
int	updateCustomerGroup(AdminCustomerGroup custGroup) Update a customer group
void	updateCustomerWithOptions(AdminCustomer cust, AdminUpdateCustomerOptions options) We must update the following tables: customers, address_book (for the default address) and customers_info
void	updateVendor(AdminVendor vendor) Update the vendor
void	updateVendor(AdminVendor vendor, java.sql.Connection con) Update the vendor
void	updateVendorReviewInfo(int vendorId) The vendor referenced by the vendorId parameter is updated with information regarding the average rating and the number of reviews present for the vendor.

Method Detail

getCustomersCount

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

Returns a count of the number of Customers

Parameters:

search - Search criteria

Returns:

A count of the number of Customers

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

getCustomers

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

Returns a set of Customers that match the search criteria

Parameters:

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

offset - the offset in the db

size - the number of records from the specified offset

Returns:

a set of customers matching the search criteria

Throws:

java.lang.Exception - an unexpected exception

getProductNotificationsForCustomer

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

Get an array of product notifications for the customer

Parameters:

customerId - Id of the customer whose product notifications will be returned

Returns:

an array of product notifications for the customer

Throws:

java.lang.Exception - an unexpected exception

updateCustomer

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

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

Parameters:

cust - the customer - must already have a good ID

Throws:

java.lang.Exception - an unexpected exception

updateCustomerWithOptions

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

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

Parameters:

cust - the customer - must already have a good ID

options - Allows you to define whether KonaKart should check that the telephone number being set is unique (does not belong to an existing registered customer).

Throws:

java.lang.Exception - an unexpected exception

deleteCustomer

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

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

Removes records from :

• 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
• TABLE_KK_WISHLIST
• TABLE_KK_WISHLIST_ITEM

Parameters :

• custId

Parameters:

custId - the custId

Returns:

returns the id of the deleted customer

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

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

A new customer is added to the system. If an admin user or registered customer already exists with the same eMail address, then an exception is thrown. 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:

int : Customer Id

Throws:

java.lang.Exception - an unexpected exception

forceRegisterCustomer

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

A new customer is added to the system. If an admin user already exists with the same eMail address, it is deleted. If a registered customer already exists with the same eMail address, then an exception is thrown. 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:

int : Customer Id

Throws:

java.lang.Exception - an unexpected exception

resetCustomerPasswordSpecifyingEmail

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

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

Parameters:

custId - Customer Id

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

Throws:

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

resetCustomerPassword

void resetCustomerPassword(int custId)
                    throws KKAdminException

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

Parameters:

custId - Customer Id

Throws:

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

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

getRandomPassword

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

Get a random password for a Customer. If length == 0, the configuration value ENTRY_PASSWORD_MIN_LENGTH is used.

Parameters:

length - the length

Returns:

Returns a random password

Throws:

java.lang.Exception - an unexpected exception

doesCustomerExistForEmail

boolean doesCustomerExistForEmail(java.lang.String emailAddr)
                           throws org.apache.torque.TorqueException,
                                  KKAdminException,
                                  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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

doesCustomerExistForId

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

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getCustomerForEmail

AdminCustomer getCustomerForEmail(java.lang.String emailAddr)
                           throws org.apache.torque.TorqueException,
                                  KKAdminException,
                                  com.workingdogs.village.DataSetException,
                                  java.lang.Exception

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

Parameters:

emailAddr - the emailAddr

Returns:

Returns a Customer object if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

java.lang.Exception - an unexpected exception

getCustomerForEmailWithOptions

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

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

Parameters:

emailAddr - the emailAddr

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

Returns:

Returns a Customer object if the customer already exists

Throws:

java.lang.Exception - an unexpected exception

getCustomerIdForEmail

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

Finds the custId of the specified customer.

Parameters:

emailAddr - the emailAddr

Returns:

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

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getCustomerForId

AdminCustomer 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

getCustomerForIdWithOptions

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

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

Parameters:

customerId - the customerId

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

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

getAddressFormatTemplate

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

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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAllAddressFormats

AdminAddressFormat[] getAllAddressFormats()
                                   throws KKAdminException

This returns an array of all the address formats

Returns:

Returns an array of all the address formats

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

sendTemplateEmailToCustomers

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

Calls sendTemplateEmailToCustomersWithOptions() with null options.

Parameters:

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

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

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

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

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

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

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

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

Throws:

java.lang.Exception - an unexpected exception

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

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

sendTemplateEmailToCustomersWithOptions

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

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

Parameters:

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

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

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

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

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

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

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

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

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

Throws:

java.lang.Exception - an unexpected exception

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

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

insertProductNotification

void insertProductNotification(int custId,
                               int prodId)
                        throws KKAdminException

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

Parameters:

custId - the customerId

prodId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteProductNotification

void deleteProductNotification(int custId,
                               int prodId)
                        throws KKAdminException

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

Parameters:

custId - the customerId

prodId - the productId

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getCustomerGroupsPerPromotion

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

Returns all of the customer groups for the promotion

Parameters:

promotionId - the promotionId

languageId - the languageId

Returns:

Array of AdminCustomerGroup Objects

Throws:

java.lang.Exception - an unexpected exception

insertCustomerGroup

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

Insert a customer group

Parameters:

custGroup - A customer group object

Returns:

returns the id of the inserted customer group

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

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

insertCustomerGroups

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

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

Parameters:

custGroups - An array of AdminCustomerGroup objects

Returns:

returns the id of the inserted objects

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updateCustomerGroup

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

Update a customer group

Parameters:

custGroup - A customer group object

Returns:

Returns the id of the customer group

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

deleteCustomerGroup

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

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

Parameters:

custGroupId - The id of a customer group object

Returns:

returns the id of the deleted customer group

Throws:

java.lang.Exception - an unexpected exception

getCustomerGroups

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

This returns an AdminCustomerGroupSearchResult object.

Parameters:

search - the search

Returns:

Returns an AdminCustomerGroupSearchResult object

Throws:

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

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Admin Customer Manager

Throws:

java.lang.Exception - an unexpected exception

getCustomersLite

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

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

Parameters:

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

offset - the offset in the db

size - the number of records from the specified offset

Returns:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

incrementLogonCount

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

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

Parameters:

customerId - the customerId

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getDbPassword

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

Get the password from the database for the given userId

Parameters:

userId - the userId

Returns:

the password from the database which is hashed

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

createMailingList

void createMailingList(AdminCustomerSearch search,
                       AdminMailListOptions listOptions)
                throws KKAdminException

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

Parameters:

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

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

addChildrenToCustomer

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

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

Parameters:

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

children - An array of AdminCustomer objects

Throws:

java.lang.Exception - an unexpected exception

doesCustomerExistForTelephone

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

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

Parameters:

telephone - the telephone

Returns:

Returns true if the customer already exists

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

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,
                                       KKAdminException,
                                       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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

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,
                                     KKAdminException,
                                     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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getVendors

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

Returns a set of Vendors that match the search criteria

Parameters:

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

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns a set of vendors matching the search criteria

Throws:

java.lang.Exception - an unexpected exception

getVendorForId

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

Return a vendor for the numeric vendorId

Parameters:

vendorId - the vendorId

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

updateVendor

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

Update the vendor

Parameters:

vendor - the vendor - must already have a good ID

Throws:

java.lang.Exception - an unexpected exception

updateVendor

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

Update the vendor

Parameters:

vendor - the vendor - must already have a good ID

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

Throws:

java.lang.Exception - an unexpected exception

insertVendor

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

Insert a vendor

Parameters:

vendor - the vendor

Returns:

Returns the id of the inserted vendor

Throws:

java.lang.Exception - an unexpected exception

deleteVendor

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

Delete a vendor

Parameters:

vendorId - the vendorId

Throws:

java.lang.Exception - an unexpected 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

addVendorToStore

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

Associates a vendor with a store

Parameters:

vendorId - the vendorId

vendorStoreId - the vendorStoreId

Throws:

java.lang.Exception - an unexpected exception

cloneCustomer

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

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

Points to note:

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

Parameters:

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

cloneCustId - The id of the customer to be cloned

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

Returns:

Returns an AdminCloneCustomerResult object

Throws:

java.lang.Exception - an unexpected exception

deleteCustomerMultiStore

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

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

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

Parameters:

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

customerId - The id of the customer to be deleted

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

Returns:

Returns an AdminDeleteCustomerResult object

Throws:

java.lang.Exception - an unexpected exception

getStoresForCustomer

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

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

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

Parameters:

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

emailAddress - The email address of the customer being searched

Returns:

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

Throws:

java.lang.Exception - an unexpected exception