Package com.softslate.commerce.businessobjects.customer

Interface CustomerProcessor

All Superinterfaces:

BusinessObject, BusinessProcessor

All Known Implementing Classes:

BasicCustomerProcessor

public interface CustomerProcessor
extends BusinessProcessor

Interface for business logic methods having to do with customer accounts and related objects. Created in the Struts layer in response to requests for information about an exisiting customer account, or to create new accounts.

When the application needs to create an instance that implements CustomerProcessor, BusinessObjectFactory finds the name of the Java class to instantiate from the "customerProcessorImplementer" setting in the appComponents.properties file.

The default "customerProcessorImplementer" is BasicCustomerProcessor.

Author:

David Tobey

Method Summary

Modifier and Type	Method	Description
Map	addCustomer(Map parameters)
void	customerChangePassword(String newDecryptedPassword, Customer customer)
void	deleteCustomer(Map parameters)
Map	editCustomer(Map parameters)
Map	editDeleteCustomers(Map parameters)
Map	loadCustomerAdvancedLostPassword(Map parameters)
Customer	loadCustomerFromID(Map parameters)
Map	loadCustomerFromResetToken(Map parameters)
Customer	loadCustomerFromUserName(Map parameters)
Map	loadCustomerLostPassword(Map parameters)	Loads the Customer property of this CustomerProcesor from the database given a Map containing the userName.
Map	loadCustomersAndCount(Map parameters)
Collection	loadDownloadFiles()	Loads the set of download files that the customer has purchased from the database.
int	loadMaxCustomerID()
Order	loadOrderDetails(Map parameters)	Loads all of the database information corresponding to a given order number for a given customer.
Map	loadOrderHistory()	Loads a customer's order history from the database.
Map	loadPreviousOrder(Map parameters)	Loads a previously placed order for a customer from the database, assigning it as the customer's current cart.
Map	loadSavedCart(Map parameters)	Loads a saved cart for a customer from the database, assigning it as the customer's current cart.
Collection	loadSavedCarts()	Loads a customer's list of saved carts from the database.
Map	processAutoLogin(Map parameters)	Processes an automatic login given a user's autoLoginToken.
Map	processChangePassword(String currentDecryptedPassword, String newDecryptedPassword)
Map	processLogin(Map parameters)	Processes a login attempt given a user name and password.
Map	processRegister(Map parameters)	Processes a request to register or add a new customer account into the system.
Map	refreshCustomerFromDatabase(User user)
Map	removeSavedCart(Map parameters)	Removes a saved cart for a customer from the database, changing the order record to a status of "Saved".
Map	resetPassword(String token, String newPassword)
Map	saveCart(Map parameters)	Saves an Order in the database as a saved cart, with a status of "Saved", which a customer can pick up later.
boolean	sendCompleteResetPasswordEmail(Customer customer)
boolean	sendLostPasswordAdvancedEmail(Customer customer)
Map	updateAddresses(Map parameters)	Updates a customer's address information.
Map	updateCustomer(Map parameters)	Updates a customer's account information.
Map	validateCustomer(Customer customer)

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject

initialize

Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessProcessor

getAppComponents, getAppSettings, getBusinessObjectFactory, getDaoFactory, getEventBus, getInjector, getSettings, getUser, setAppComponents, setAppSettings, setBusinessObjectFactory, setDaoFactory, setEventBus, setInjector, setSettings, setUser, utils

Method Details

processRegister

Map processRegister(Map parameters)
             throws Exception

Processes a request to register or add a new customer account into the system. The incoming Map should have at least two keys: userName and decryptedPassword, which will be used for the new account. If successful, the customer property of the current User will be populated with the new account's information. If an account already exists with the same userName, the returned Map will contain a key named "resultCode" whose value is "errors.userAlreadyLoggedIn". This code is used in the Struts layer to look up the error message.

Parameters:

parameters - A Map containing the user name and password for the new customer account.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

processLogin

Map processLogin(Map parameters)
          throws Exception

Processes a login attempt given a user name and password. The incoming Map must have two keys: userName and password. If the login attempt succeeds, the Customer property of the current User will be populated with the database information for the customer account. If the user name and password don't match an account in the database, the returned Map will contain a key named "resultCode" whose value is "errors.invalidLogin". This code is used in the Struts layer to look up the error message.

Parameters:

parameters - A Map containing the user name and password for the customer attempting to log in.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

processAutoLogin

Map processAutoLogin(Map parameters)
              throws Exception

Processes an automatic login given a user's autoLoginToken. The incoming Map must have the key: autoLoginToken. If the login succeeds, the Customer property of the current User will be populated with the database information for the customer account. If the autoLoginToken doesn't match an account in the database, the returned Map will contain a key named "resultCode" whose value is "errors.invalidLogin".

Parameters:

parameters - A Map containing the autoLoginToken for the customer.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

updateAddresses

Map updateAddresses(Map parameters)
             throws Exception

Updates a customer's address information. The incoming Map should contain keys corresponding to the delivery address properties of CustomerAddress, and the billing address properties of Customer. The Customer property of the current user, and the first CustomerAddress in the customerAddressCollection of the Customer are modified with the incoming address information. Then the database records for the customer and the customer address are updated in sscCustomer and sscCustomerAddress.

Parameters:

parameters - A Map containing the address information for the current user, which is to be used to update the account.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

updateCustomer

Map updateCustomer(Map parameters)
            throws Exception

Updates a customer's account information. The incoming Map should contain keys corresponding to the properties of Customer. The Customer property of the current user is modified with the account information contained in the incoming Map. Then the database record for the customer is updated. Used to process a changed user name and password.

If the incoming user name is already used by a different customer, the returned Map will contain a key named "resultCode" whose value is "errors.userNameNotUnique". This code is used in the Struts layer to look up the error message.

Parameters:

parameters - A Map containing the account information for the current user, which is to be used to update the account.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

loadCustomerLostPassword

Map loadCustomerLostPassword(Map parameters)
                      throws Exception

Loads the Customer property of this CustomerProcesor from the database given a Map containing the userName. Used in the lost password form, when a customer must be retrieved from database without a password.

If the application is set to use one-way encryption for customer passwords, this method will generate a random password and update the customer's record with it.

If the customer corresponding to the user name in the Map does not exist in the database, the returned Map will contain a key named "resultCode" whose value is "errors.userNameNotFound". This code is used in the Struts layer to look up the error message.

Parameters:

parameters - A Map containing the user name of a given customer.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

loadOrderHistory

Map loadOrderHistory()
              throws Exception

Loads a customer's order history from the database. If successful, the Customer property of the current User will have its orderHistory property populated with information from the database about all of the customer's previous orders in the store.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

loadOrderDetails

Order loadOrderDetails(Map parameters)
                throws Exception

Loads all of the database information corresponding to a given order number for a given customer. Used to retrieve the order details for a customer viewing his or her order history.

Parameters:

parameters - A Map containing a key named orderNumber with the order number of a given order.

Returns:

An Order populated with information from the database.

Throws:

Exception

loadDownloadFiles

Collection loadDownloadFiles()
                      throws Exception

Loads the set of download files that the customer has purchased from the database. The set of files is determined by querying the sscProductSetting table for download files associated with products that the customer has purchased previously.

Returns:

A Collection of Maps, one for each file available for download by the customer.

Throws:

Exception

saveCart

Map saveCart(Map parameters)
      throws Exception

Saves an Order in the database as a saved cart, with a status of "Saved", which a customer can pick up later.

Parameters:

parameters - A Map containing arguments, by default null.

Returns:

A Map with a key named "resultCode", equal to "0" if the result is successful.

Throws:

Exception

loadSavedCarts

Collection loadSavedCarts()
                   throws Exception

Loads a customer's list of saved carts from the database. Saved carts are stored as incomplete orders in the sscOrder database table with a status of "Saved".

Returns:

A Collection of Order objects representing the customer's saved carts.

Throws:

Exception

loadSavedCart

Map loadSavedCart(Map parameters)
           throws Exception

Loads a saved cart for a customer from the database, assigning it as the customer's current cart. Saved carts are stored as incomplete orders in the sscOrder database table with a status of "Saved".

Parameters:

parameters - A Map containing a key named orderID with the order id of a given order.

Returns:

A Map object containing the results of the reprocessing of the order, or null, if the refreshSaved Carts setting is false.

Throws:

Exception

removeSavedCart

Map removeSavedCart(Map parameters)
             throws Exception

Removes a saved cart for a customer from the database, changing the order record to a status of "Saved".

Parameters:

parameters - A Map containing a key named orderID with the order id of a given order.

Returns:

null in this implementation.

Throws:

Exception

loadPreviousOrder

Map loadPreviousOrder(Map parameters)
               throws Exception

Loads a previously placed order for a customer from the database, assigning it as the customer's current cart.

Parameters:

parameters - A Map containing a key named orderID with the order id of a given order.

Returns:

A Map object containing the results of the reprocessing of the order, or null, if the refreshReorders setting is false

Throws:

Exception

loadCustomersAndCount

Map loadCustomersAndCount(Map parameters)
                   throws Exception

Throws:

Exception

addCustomer

Map addCustomer(Map parameters)
         throws Exception

Throws:

Exception

validateCustomer

Map validateCustomer(Customer customer)
              throws Exception

Throws:

Exception

loadCustomerFromID

Customer loadCustomerFromID(Map parameters)
                     throws Exception

Throws:

Exception

editCustomer

Map editCustomer(Map parameters)
          throws Exception

Throws:

Exception

loadCustomerFromUserName

Customer loadCustomerFromUserName(Map parameters)
                           throws Exception

Throws:

Exception

editDeleteCustomers

Map editDeleteCustomers(Map parameters)
                 throws Exception

Throws:

Exception

deleteCustomer

void deleteCustomer(Map parameters)
             throws Exception

Throws:

Exception

loadMaxCustomerID

int loadMaxCustomerID()
               throws Exception

Throws:

Exception

loadCustomerAdvancedLostPassword

Map loadCustomerAdvancedLostPassword(Map parameters)
                              throws Exception

Throws:

Exception

loadCustomerFromResetToken

Map loadCustomerFromResetToken(Map parameters)
                        throws Exception

Throws:

Exception

resetPassword

Map resetPassword(String token,
 String newPassword)
           throws Exception

Throws:

Exception

processChangePassword

Map processChangePassword(String currentDecryptedPassword,
 String newDecryptedPassword)
                   throws Exception

Throws:

Exception

customerChangePassword

void customerChangePassword(String newDecryptedPassword,
 Customer customer)
                     throws Exception

Throws:

Exception

sendLostPasswordAdvancedEmail

boolean sendLostPasswordAdvancedEmail(Customer customer)
                               throws Exception

Throws:

Exception

sendCompleteResetPasswordEmail

boolean sendCompleteResetPasswordEmail(Customer customer)
                                throws Exception

Throws:

Exception

refreshCustomerFromDatabase

Map refreshCustomerFromDatabase(User user)
                         throws Exception

Throws:

Exception