com.dpslink.flash.db.util

Class AccountCreateHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.AccountCreateHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class AccountCreateHandler
extends DBUHandler

Handles the creation of a user account and all of its associated data (user, billing customer, shipping customers).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ivBackendBillto A flag that indicates if a backend bill-to customer was created.
private boolean	ivBackendShipto A flag that indicates if a backend ship-to customer was created.
private boolean	ivBackendUser A flag that indicates if a backend user record was created.
private Customer	ivBillto The bill-to customer object for the new account.
private java.lang.String	ivCreateBy The user id that initiated the create.
private ICustomerMaintenance	ivCustomerMaint A reference to the Customer Maintenance Interface object.
private boolean	ivNotificationContact A flag that indicates if a notification framework contact record was created.
private Customer	ivShipto The ship-to customer object for the new account.
private User	ivUser The user object for the new account.
private IUserMaintenance	ivUserMaint A reference to the User Maintenance Interface object.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.db.util.DBUHandler

ivContext

Constructor Summary

Constructors

Constructor and Description
AccountCreateHandler() Constructs a new instance of the account create handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
User	createAccount(User user, java.lang.String createBy) Creates the given user account and its associated data (user, billing customer, shipping customer).
private boolean	createAccountBillto() Creates a new account's bill-to customer.
private boolean	createAccountPermits() Creates a new account's default user permit record(s).
private boolean	createAccountPermitsCustId() Creates a new account's default user permit record(s) when the site is configured for permits by assigned customer.
private boolean	createAccountPermitsShipId() Creates a new account's default user permit record(s) when the site is configured for permits by ship-to customer.
boolean	createAccountPermitsShipId(Customer baseon, Customer shipto) Creates default user permit record(s) for a ship-to customer using the permits that exist for a based-on customer.
private boolean	createAccountPermitsUserId() Creates a new account's default user permit record(s) when the site is configured for permits by user.
private boolean	createAccountPreferences() Creates a new account's user notification preference record(s).
private boolean	createAccountShipto() Creates a new account's ship-to customer.
private boolean	createAccountUser() Creates a new account's user.
private void	deleteAccount() Deletes the backend database records that might have been created.
private java.lang.String	generateLogonId(java.lang.String custid) Auto-generates a user logon id based on the given customer id.
private java.util.ArrayList<Customer>	getAccountShiptos() Returns a collection of all ship-to customers for the account being created.
private Customer	getDefaultShipto(Customer cust) Retrieves the default ship-to customer for the given customer based on the given customer's shipforid.
private Customer	getExistingCustomer(java.lang.String custid) Retrieves the customer for the given customer id.
private boolean	getReferencedCustomers(Customer cust) Retrieves the customers referenced by the given customer (bill-to and all ship-tos).
private void	log(java.lang.String msgid, java.lang.String[] values) A convenience method used for logging messages.
void	setContext(FlashServletContext ctx) Sets the class' servlet context (i.e.
boolean	validateCustomer(java.lang.String custid) Validates the given customer id value.
boolean	validateUser(java.lang.String userid) Validates the given user id value.

Methods inherited from class com.dpslink.flash.db.util.DBUHandler

getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivUser

private User ivUser

The user object for the new account.

ivBillto

private Customer ivBillto

The bill-to customer object for the new account.

ivShipto

private Customer ivShipto

The ship-to customer object for the new account.

ivCreateBy

private java.lang.String ivCreateBy

The user id that initiated the create.

ivCustomerMaint

private ICustomerMaintenance ivCustomerMaint

A reference to the Customer Maintenance Interface object.

ivUserMaint

private IUserMaintenance ivUserMaint

A reference to the User Maintenance Interface object.

ivBackendBillto

private boolean ivBackendBillto

A flag that indicates if a backend bill-to customer was created.

ivBackendShipto

private boolean ivBackendShipto

A flag that indicates if a backend ship-to customer was created.

ivBackendUser

private boolean ivBackendUser

A flag that indicates if a backend user record was created.

ivNotificationContact

private boolean ivNotificationContact

A flag that indicates if a notification framework contact record was created.

Constructor Detail

AccountCreateHandler

public AccountCreateHandler()

Constructs a new instance of the account create handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

setContext

public void setContext(FlashServletContext ctx)

Sets the class' servlet context (i.e. the current context for the servlet or thread using the class). Overrides setContext in DBUHandler.

Specified by:

setContext in interface DBUInterface

Overrides:

setContext in class DBUHandler

Parameters:

ctx - (FlashServletContext) The current servlet or thread context.

createAccount

public User createAccount(User user,
                          java.lang.String createBy)

Creates the given user account and its associated data (user, billing customer, shipping customer).

When invoked and no bill-to customer id is supplied:

• creates a new bill-to customer record in the backend and frontend customer dbs for the billing information
• creates a new ship-to customer record in the backend and frontend customer dbs for the shipping information (if the shipping information is different than the billing information)
• creates a new user record in the frontend user db

When invoked and a bill-to customer id is supplied (admin or sfi/csr create account only):

• if necessary, retrieves backend customer record(s) for billing and shipping information and creates corresponding frontend records
• creates a new user record in the frontend user db

Parameters:

user - (User) The user for the account that is to be created.

createBy - (String) The user id that initiated the create.

Returns:

User - The given user object with any additional attributes assigned during the create process, or null if the create failed.

createAccountBillto

private boolean createAccountBillto()
                             throws java.lang.Exception

Creates a new account's bill-to customer.

Returns:

boolean - true if the bill-to customer creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the bill-to customer.

createAccountShipto

private boolean createAccountShipto()
                             throws java.lang.Exception

Creates a new account's ship-to customer.

Returns:

boolean - true if the ship-to customer creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the ship-to customer.

createAccountUser

private boolean createAccountUser()
                           throws java.lang.Exception

Creates a new account's user. Invoked by the createAccount method.

Returns:

boolean - true if the user creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the user.

createAccountPermits

private boolean createAccountPermits()
                              throws java.lang.Exception

Creates a new account's default user permit record(s). Invoked by the createAccountUser method.

Returns:

boolean - true if the permit creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the permits.

createAccountPermitsCustId

private boolean createAccountPermitsCustId()
                                    throws java.lang.Exception

Creates a new account's default user permit record(s) when the site is configured for permits by assigned customer. If permits already exist for the assigned customer, then this method does nothing. Invoked by the createAccountPermits method.

Returns:

boolean - true if the permit creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the permits.

createAccountPermitsShipId

private boolean createAccountPermitsShipId()
                                    throws java.lang.Exception

Creates a new account's default user permit record(s) when the site is configured for permits by ship-to customer. Invoked by the createAccountPermits method.

Returns:

boolean - true if the permit creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the permits.

createAccountPermitsShipId

public boolean createAccountPermitsShipId(Customer baseon,
                                          Customer shipto)

Creates default user permit record(s) for a ship-to customer using the permits that exist for a based-on customer. If permits already exist for the ship-to, then this method does nothing.

Parameters:

baseon - (Customer) The customer on which to base the ship-to's permits.

shipto - (Customer) The ship-to customer to process.

Returns:

boolean - true if the permit creation completed successfully, otherwise false.

createAccountPermitsUserId

private boolean createAccountPermitsUserId()
                                    throws java.lang.Exception

Creates a new account's default user permit record(s) when the site is configured for permits by user. If permits already exist for the user, then this method does nothing. Invoked by the createAccountPermits method.

Returns:

boolean - true if the permit creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the permits.

createAccountPreferences

private boolean createAccountPreferences()
                                  throws java.lang.Exception

Creates a new account's user notification preference record(s). Invoked by the createAccountUser method.

Returns:

boolean - true if the preferences creation completed successfully, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while creating the preferences.

deleteAccount

private void deleteAccount()

Deletes the backend database records that might have been created. Some or all of the records for a new account may not have been created due to a failure during the create process. Also deletes notification framework contact info that might have been created.

generateLogonId

private java.lang.String generateLogonId(java.lang.String custid)
                                  throws java.lang.Exception

Auto-generates a user logon id based on the given customer id. If a logon id cannot be created from the given customer id, a random number is then assigned.

Parameters:

custid - (String) The customer id on which to base the auto generation.

Returns:

String - The auto-generated logon id.

Throws:

java.lang.Exception - - if an error occurs while generating the logon id.

getAccountShiptos

private java.util.ArrayList<Customer> getAccountShiptos()
                                                 throws java.lang.Exception

Returns a collection of all ship-to customers for the account being created.

Returns:

ArrayList - The account's ship-to customers.

Throws:

java.lang.Exception - - if an error occurs while retrieving the ship-to customers.

getDefaultShipto

private Customer getDefaultShipto(Customer cust)
                           throws java.lang.Exception

Retrieves the default ship-to customer for the given customer based on the given customer's shipforid. If the ship-to customer has not yet been setup in the Flash db, it is retrieved from the backend.

Parameters:

cust - (Customer) The Customer whose default ship-to is to be retrieved.

Returns:

Customer - The default ship-to Customer for the given customer, or null if the ship-to customer could not be retrieved.

Throws:

java.lang.Exception - - if an error occurs while retrieving the customer.

getExistingCustomer

private Customer getExistingCustomer(java.lang.String custid)
                              throws java.lang.Exception

Retrieves the customer for the given customer id. If the customer has not yet been setup in the Flash db, the customer, its bill-to customer and all of its ship-to customers are retrieved from the backend.

Parameters:

custid - (String) The id of the customer to retrieve.

Returns:

Customer - The Customer for the specified customer id, or null if the customer could not be retrieved.

Throws:

java.lang.Exception - - if an error occurs while retrieving the customer.

getReferencedCustomers

private boolean getReferencedCustomers(Customer cust)
                                throws java.lang.Exception

Retrieves the customers referenced by the given customer (bill-to and all ship-tos). If any of the referenced customers have not yet been setup in the Flash db, they are retrieved from the backend.

Parameters:

cust - (Customer) The Customer whose referenced customers are to be retrieved.

Returns:

boolean - true if the referenced customers could all be retrieved, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while retrieving the referenced customers.

log

private void log(java.lang.String msgid,
                 java.lang.String[] values)
          throws java.lang.Exception

A convenience method used for logging messages.

Parameters:

msgid - (String) The resource key for the message to retrieve.

values - (String[]) An array of values to replace in message.

Throws:

java.lang.Exception - - if an error occurs while logging the message.

validateCustomer

public boolean validateCustomer(java.lang.String custid)

Validates the given customer id value. Determines if the customer id exists in either the frontend database or in the backend database.

Parameters:

custid - (String) The id of the customer to validate.

Returns:

boolean - true if the customer exists in either database, otherwise false.

validateUser

public boolean validateUser(java.lang.String userid)

Validates the given user id value. Determines if the user id exists in either the frontend database or in the backend database.

Parameters:

userid - (String) The id of the user to validate.

Returns:

boolean - true if the user does not exist in either database, otherwise false.