com.dpslink.flash.imports

Class UserImport

java.lang.Object

com.dpslink.flash.imports.Import<User>

com.dpslink.flash.imports.UserImport

All Implemented Interfaces:

java.io.Serializable

public class UserImport
extends Import<User>

Handles importing of users.

NOTE: A single instance of this class is cached by ImportProcessor and used throughout the import processing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Customer	ivCustomer The current customer.
private User	ivDefaultUser The default user (User.DEFAULT_USER)
private boolean	ivEmailAcctInfo A flag indicating if emailing account info is active.
private AccountEmailHandler	ivEmailHandler An instance of the account info email handler.
private boolean	ivExtendedInfo A flag indicating if contact extended info is active.
private FavoritesDescriptor	ivFavoritesDesc A favorites descriptor object.
private java.util.ArrayList<FavoritesDescriptor>	ivFavoritesDescs A cache of all favorites descriptors.
private int	ivIdMaxLen The configured logon id maximum length.
private int	ivIdMinLen The configured logon id minimum length.
private int	ivPwdMaxLen The configured password maximum length.
private int	ivPwdMinLen The configured password minimum length.
private SecurityProfile	ivSecurityProfile A security profile object.
private java.util.ArrayList<SecurityProfile>	ivSecurityProfiles A cache of all security profiles.
private Customer	ivShipto The current ship-to customer.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.flash.imports.Import

ACTION_ADD, ACTION_CLEAR, ACTION_DELETE, ACTION_UPDATE, ACTION_UPDATE_ADD, ivContext, ivLineNo, ivNumFields, ivObject, ivStarAll, ivTextLine, ivUseMixedCase, ivValues

Constructor Summary

Constructors

Constructor and Description
UserImport() Constructs a new user import class.

Method Summary

Modifier and Type	Method and Description
protected boolean	addRecord() Adds a new record to the Flash database.
protected boolean	deleteRecord() Deletes an existing record from the Flash database.
private void	emailAccountInfo(User user) Sends an email notification containing account info to the given user.
void	housekeeping() Garbage collection: Kills (nullifies) objects used by the import class.
boolean	importData(int action, java.util.ArrayList<java.lang.String> data, int lineNo) Imports a record of data values into the Flash database.
void	setContext(FlashServletContext ctx) Sets the import object's servlet context (i.e.
protected boolean	updateRecord() Updates an existing record in the Flash database.
private boolean	validChanges() Answers if the results of changing various fields are valid.
private boolean	validCustomer(java.lang.String id, boolean shipto) Answers if a customer exists in the Flash database.
private boolean	validFavoritesDescriptor(java.lang.String id) Answers if a favorites descriptor exists in the Flash database.
protected boolean	validForAdd() Answers if appropriate data has been supplied in order to add a record to the Flash database.
protected boolean	validForDelete() Answers if appropriate data has been supplied in order to delete a record in the Flash database.
protected boolean	validForUpdate() Answers if appropriate data has been supplied in order to update a record in the Flash database.
private boolean	validPhone(java.lang.String phone, java.lang.String desc, java.lang.String setnum) Answers if a phone number and phone description combination are valid.
private boolean	validSecurityProfile(java.lang.String code) Answers if a security profile exists in the Flash database.

Methods inherited from class com.dpslink.flash.imports.Import

getContext, getMixedCase, getNumFields, getProperty, getTrueAction, isDecimal, isInteger, isStarAll, isTrue, log, log, qualifyKey, qualifyMsgId, setTextLine

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

ivIdMinLen

private int ivIdMinLen

The configured logon id minimum length.

ivIdMaxLen

private int ivIdMaxLen

The configured logon id maximum length.

ivPwdMinLen

private int ivPwdMinLen

The configured password minimum length.

ivPwdMaxLen

private int ivPwdMaxLen

The configured password maximum length.

ivExtendedInfo

private boolean ivExtendedInfo

A flag indicating if contact extended info is active.

ivEmailAcctInfo

private boolean ivEmailAcctInfo

A flag indicating if emailing account info is active.

ivEmailHandler

private AccountEmailHandler ivEmailHandler

An instance of the account info email handler.

ivDefaultUser

private User ivDefaultUser

The default user (User.DEFAULT_USER)

ivFavoritesDesc

private FavoritesDescriptor ivFavoritesDesc

A favorites descriptor object.

ivFavoritesDescs

private java.util.ArrayList<FavoritesDescriptor> ivFavoritesDescs

A cache of all favorites descriptors.

ivSecurityProfile

private SecurityProfile ivSecurityProfile

A security profile object.

ivSecurityProfiles

private java.util.ArrayList<SecurityProfile> ivSecurityProfiles

A cache of all security profiles.

ivCustomer

private Customer ivCustomer

The current customer.

ivShipto

private Customer ivShipto

The current ship-to customer.

Constructor Detail

UserImport

public UserImport()

Constructs a new user import class.

Method Detail

setContext

public void setContext(FlashServletContext ctx)

Sets the import object's servlet context (i.e. the current context for the servlet or thread using the object). Overrides setContext in Import.

Overrides:

setContext in class Import<User>

Parameters:

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

housekeeping

public void housekeeping()

Garbage collection: Kills (nullifies) objects used by the import class. Overrides housekeeping in Import.

Specified by:

housekeeping in class Import<User>

importData

public boolean importData(int action,
                          java.util.ArrayList<java.lang.String> data,
                          int lineNo)

Imports a record of data values into the Flash database. Overrides importData in Import.

Specified by:

importData in class Import<User>

Parameters:

action - (int) The action code (i.e. add, update, delete).

data - (ArrayList) The set of data values to be imported. Each element corresponds to a field in the original text line.

lineNo - (int) The current line number being processed

Returns:

boolean - true if the import of data was successful, otherwise false.

addRecord

protected boolean addRecord()

Adds a new record to the Flash database. Overrides addRecord in Import.

Specified by:

addRecord in class Import<User>

Returns:

boolean - true if the add was successful, otherwise false.

deleteRecord

protected boolean deleteRecord()

Deletes an existing record from the Flash database. Overrides deleteRecord in Import.

Specified by:

deleteRecord in class Import<User>

Returns:

boolean - true if the delete was successful, otherwise false.

updateRecord

protected boolean updateRecord()

Updates an existing record in the Flash database. Overrides updateRecord in Import.

Specified by:

updateRecord in class Import<User>

Returns:

boolean - true if the update was successful, otherwise false.

validForAdd

protected boolean validForAdd()

Answers if appropriate data has been supplied in order to add a record to the Flash database. Overrides validForAdd in Import.

Specified by:

validForAdd in class Import<User>

Returns:

boolean - true if appropriate data has been supplied, otherwise false.

validForDelete

protected boolean validForDelete()

Answers if appropriate data has been supplied in order to delete a record in the Flash database. Overrides validForDelete in Import.

Specified by:

validForDelete in class Import<User>

Returns:

boolean - true if appropriate data has been supplied, otherwise false.

validForUpdate

protected boolean validForUpdate()

Answers if appropriate data has been supplied in order to update a record in the Flash database. Overrides validForUpdate in Import.

Specified by:

validForUpdate in class Import<User>

Returns:

boolean - true if appropriate data has been supplied, otherwise false.

validChanges

private boolean validChanges()

Answers if the results of changing various fields are valid. Invoked by updateRecord after all changed fields have been applied to the user being updated (but before update actually occurs).

Returns:

boolean - true if the change results are valid, otherwise false.

validCustomer

private boolean validCustomer(java.lang.String id,
                              boolean shipto)

Answers if a customer exists in the Flash database.

Parameters:

id - (String) The customer id for the customer to check.

shipto - (boolean) true if the customer being checked is a ship-to, otherwise false.

Returns:

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

validFavoritesDescriptor

private boolean validFavoritesDescriptor(java.lang.String id)

Answers if a favorites descriptor exists in the Flash database.

Parameters:

id - (String) The id for the favorites descriptor to check.

Returns:

boolean - true if the favorites descriptor exists in the database, otherwise false.

validPhone

private boolean validPhone(java.lang.String phone,
                           java.lang.String desc,
                           java.lang.String setnum)

Answers if a phone number and phone description combination are valid.

Parameters:

phone - (String) The phone number to check.

desc - (String) The phone description to check.

setnum - (String) The set of phone fields being checked (1-4).

Returns:

boolean - true if the field combination is valid, otherwise false.

validSecurityProfile

private boolean validSecurityProfile(java.lang.String code)

Answers if a security profile exists in the Flash database.

Parameters:

code - (String) The code for the security profile to check.

Returns:

boolean - true if the security profile exists in the database, otherwise false.

emailAccountInfo

private void emailAccountInfo(User user)

Sends an email notification containing account info to the given user.

Parameters:

user - (User) The user the email is to be sent to.