com.dpslink.flash.db.util

Class AccountDeleteHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.AccountDeleteHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class AccountDeleteHandler
extends DBUHandler

Handles the deletion of a user account and all of its associated data (credit cards, favorite items, customers, sales rep users, sales rep customers).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ICustomerMaintenance	ivCustomerMaint A reference to the Customer Maintenance Interface object.
private boolean	ivFromImport A flag indicating if the handler was invoked from import processing.
private java.util.ArrayList<Customer>	ivProcessed A collection of customers that have been processed.
private java.lang.String	ivUpdateBy The user Id of the person who intiated the delete.
private User	ivUser The object for the user being deleted.
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
AccountDeleteHandler() Constructs a new instance of the account delete handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
private boolean	canDeleteCustomerBilltos(java.util.ArrayList<Customer> billtos) Determines if the customers in the given set of bill-tos can be deleted.
private boolean	canDeleteCustomerRec(Customer customer) Determines if the record for the given customer can be deleted by checking to see if any other users have the customer assigned as their customer or ship-to.
private boolean	canDeleteCustomerSet(Customer customer) Determines if the set of customers (customer, bill-to, ship-tos) for the given customer can be deleted by checking to see if any references to the set are assigned to any users.
private boolean	canDeleteCustomerShiptos(java.util.ArrayList<Customer> shiptos) Determines if the customers in the given set of ship-tos can be deleted.
boolean	deleteAccount(User user) Deletes the given user account and its associated data (credit cards, favorite items, customers, sales rep customers, sales rep users).
boolean	deleteAccount(User user, boolean fromImport) Deletes the given user account and its associated data (credit cards, favorite items, customers, sales rep customers, sales rep users).
private boolean	deleteCreditCards() Deletes the credit cards for the user being processed.
private boolean	deleteCustomerBilltos(java.util.ArrayList<Customer> billtos) Deletes the customers in the given collection of bill-tos.
private boolean	deleteCustomerRec(Customer customer) Deletes a given customer record and any associated sales rep customers.
private boolean	deleteCustomerSet(Customer customer) Deletes the set of customers (customer, bill-to, ship-tos) for the given customer.
private boolean	deleteCustomerShiptos(java.util.ArrayList<Customer> shiptos) Deletes the customers in the given collection of ship-tos.
private boolean	deleteFavoriteItems() Deletes the favorite items for the user being processed.
private boolean	deleteNotificationPrefs() Deletes the notification preferences for the user being processed.
private boolean	deletePasswordHistory() Deletes the password history for the user being processed.
private boolean	deleteSalesRepCustomers(Customer customer) Deletes the sales rep customers for a given customer.
private boolean	deleteSalesRepUser() Deletes the sales rep user for the user being processed.
private boolean	deleteUser() Deletes the user being processed.
private boolean	deleteUserCustomers() Deletes the customers for the user being processed.
private boolean	deleteUserPermits(java.lang.String deleteId) Deletes the user permits for a given id (user id or customer id).
private java.util.ArrayList<Customer>	getBilltoCustomers(Customer customer) Returns a collection of all customers having the given customer as their bill-to customer.
private java.util.ArrayList<Customer>	getShiptoCustomers(Customer customer) Returns a collection of all ship-to customers for the given customer.
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.

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 object for the user being deleted.

ivUpdateBy

private java.lang.String ivUpdateBy

The user Id of the person who intiated the delete.

ivCustomerMaint

private ICustomerMaintenance ivCustomerMaint

A reference to the Customer Maintenance Interface object.

ivUserMaint

private IUserMaintenance ivUserMaint

A reference to the User Maintenance Interface object.

ivProcessed

private java.util.ArrayList<Customer> ivProcessed

A collection of customers that have been processed. Used to prevent a customer from being processed more than once so as to avoid causing a never-ending loop.

ivFromImport

private boolean ivFromImport

A flag indicating if the handler was invoked from import processing.

Constructor Detail

AccountDeleteHandler

public AccountDeleteHandler()

Constructs a new instance of the account delete 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.

deleteAccount

public boolean deleteAccount(User user)

Deletes the given user account and its associated data (credit cards, favorite items, customers, sales rep customers, sales rep users).

Parameters:

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

Returns:

boolean - true if the account delete is successful, otherwise false.

deleteAccount

public boolean deleteAccount(User user,
                             boolean fromImport)

Deletes the given user account and its associated data (credit cards, favorite items, customers, sales rep customers, sales rep users).

Parameters:

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

fromImport - (boolean) true if invoked from import processing, otherwise false.

Returns:

boolean - true if the account delete is successful, otherwise false.

deleteCreditCards

private boolean deleteCreditCards()
                           throws java.lang.Exception

Deletes the credit cards for the user being processed.

Returns:

boolean - true if the credit card deletes are successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the user's credit cards.

deleteCustomerRec

private boolean deleteCustomerRec(Customer customer)
                           throws java.lang.Exception

Deletes a given customer record and any associated sales rep customers.

• deletes any associated sales rep customers from the front-end db.
• deletes the given customer's permits from the front-end db.
• deletes the given customer from the back-end & front-end dbs.
• does not delete from back-end if this is a delete from import.

Parameters:

customer - (Customer) The customer that is to be deleted.

Returns:

boolean - true if the customer successfully deletes; otherwise false.

Throws:

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

deleteCustomerSet

private boolean deleteCustomerSet(Customer customer)
                           throws java.lang.Exception

Deletes the set of customers (customer, bill-to, ship-tos) for the given customer.

Parameters:

customer - (Customer) The customer to be deleted.

Returns:

boolean - true if the customer's set of customers is sucessfully deleted; otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the customer's set of customers.

deleteCustomerBilltos

private boolean deleteCustomerBilltos(java.util.ArrayList<Customer> billtos)
                               throws java.lang.Exception

Deletes the customers in the given collection of bill-tos.

Parameters:

billtos - (ArrayList) The set of bill-tos to be deleted.

Returns:

boolean - true if the customer deletes are successful, otherwise false.

Throws:

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

deleteCustomerShiptos

private boolean deleteCustomerShiptos(java.util.ArrayList<Customer> shiptos)
                               throws java.lang.Exception

Deletes the customers in the given collection of ship-tos.

Parameters:

shiptos - (ArrayList) The set of ship-tos to be deleted.

Returns:

boolean - true if the customer deletes are successful, otherwise false.

Throws:

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

deleteFavoriteItems

private boolean deleteFavoriteItems()
                             throws java.lang.Exception

Deletes the favorite items for the user being processed.

Returns:

boolean - true if the favorite item deletes are successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the user's favorite items.

deleteNotificationPrefs

private boolean deleteNotificationPrefs()
                                 throws java.lang.Exception

Deletes the notification preferences for the user being processed.

Returns:

boolean - true if the preferences deletes are successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the user's notification preferences.

deletePasswordHistory

private boolean deletePasswordHistory()
                               throws java.lang.Exception

Deletes the password history for the user being processed.

Returns:

boolean - true if the password history deletes are successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the user's password history.

deleteSalesRepCustomers

private boolean deleteSalesRepCustomers(Customer customer)
                                 throws java.lang.Exception

Deletes the sales rep customers for a given customer.

Parameters:

customer - (Customer) The customer whose sales rep customers are to be deleted.

Returns:

boolean - true if the sales rep customer delete is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the sales rep customers.

deleteSalesRepUser

private boolean deleteSalesRepUser()
                            throws java.lang.Exception

Deletes the sales rep user for the user being processed.

Returns:

boolean - true if the sales rep user delete is successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the sales rep user.

deleteUser

private boolean deleteUser()
                    throws java.lang.Exception

Deletes the user being processed.

Returns:

boolean - true if the user delete is successful, otherwise false.

Throws:

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

deleteUserCustomers

private boolean deleteUserCustomers()
                             throws java.lang.Exception

Deletes the customers for the user being processed.

Returns:

boolean - true if the customer deletes are successful, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while deleting the user's customers.

deleteUserPermits

private boolean deleteUserPermits(java.lang.String deleteId)
                           throws java.lang.Exception

Deletes the user permits for a given id (user id or customer id).

Parameters:

deleteId - (String) The id (user or customer) to delete.

Returns:

boolean - true if the user permit delete is successful, otherwise false.

Throws:

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

canDeleteCustomerRec

private boolean canDeleteCustomerRec(Customer customer)
                              throws java.lang.Exception

Determines if the record for the given customer can be deleted by checking to see if any other users have the customer assigned as their customer or ship-to.

Parameters:

customer - (Customer) The customer to be checked.

Returns:

boolean - true if the given customer can be deleted; otherwise false.

Throws:

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

canDeleteCustomerSet

private boolean canDeleteCustomerSet(Customer customer)
                              throws java.lang.Exception

Determines if the set of customers (customer, bill-to, ship-tos) for the given customer can be deleted by checking to see if any references to the set are assigned to any users.

Parameters:

customer - (Customer) The customer to be checked.

Returns:

boolean - true if the set of customers for the given customer can be deleted; otherwise false.

Throws:

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

canDeleteCustomerBilltos

private boolean canDeleteCustomerBilltos(java.util.ArrayList<Customer> billtos)
                                  throws java.lang.Exception

Determines if the customers in the given set of bill-tos can be deleted.

Parameters:

billtos - (ArrayList) The set of bill-tos to be processed.

Returns:

boolean - true if all bill-tos in the given set can be deleted; otherwise false.

Throws:

java.lang.Exception - - if an error occurs while processing the set of bill-tos.

canDeleteCustomerShiptos

private boolean canDeleteCustomerShiptos(java.util.ArrayList<Customer> shiptos)
                                  throws java.lang.Exception

Determines if the customers in the given set of ship-tos can be deleted.

Parameters:

shiptos - (ArrayList) The set of ship-tos to be processed.

Returns:

boolean - true if all ship-tos in the given set can be deleted; otherwise false.

Throws:

java.lang.Exception - - if an error occurs while processing the set of ship-tos.

getBilltoCustomers

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

Returns a collection of all customers having the given customer as their bill-to customer.

Parameters:

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

Returns:

ArrayList - The given bill-to customer's referenced customers.

Throws:

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

getShiptoCustomers

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

Returns a collection of all ship-to customers for the given customer.

Parameters:

customer - (Customer) The customer whose ship-to customers are to be retrieved.

Returns:

ArrayList - The given customer's ship-to customers.

Throws:

java.lang.Exception - - if an error occurs while retrieving the ship-to 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.