com.dpslink.flash.db

Class UserController

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObjectController<User>

com.dpslink.flash.db.UserController

All Implemented Interfaces:

java.io.Serializable

public class UserController
extends JDBCObjectController<User>

The controller for the User class. Provides methods for retrieving and persisting user table records in the database.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.jdbc.JDBCObjectController

ivDBObjCls, ivFieldCount, ivFieldKeyAlt, ivFieldKeyPri, ivFieldResPfx, ivSyncLast, ivSyncType, ivTableName

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
UserController() The constructor for the controller.

Method Summary

Modifier and Type	Method and Description
boolean	deleteType(java.lang.String type) Deletes all records from the user table for the given user type.
User	get(java.lang.String id) Returns the user record for the given user id.
java.lang.Object[]	getAllAsRS() Returns a result set of all user records.
java.util.ArrayList<java.lang.String>	getAutoCompleteIds(java.lang.String chars, java.lang.String type) Returns a collection of user ids that begin with the given characters.
java.util.ArrayList<java.lang.String>	getBilltoUserIds(java.lang.String billtoId) Returns a collection of user ids that have the specified bill-to customer assigned to them.
java.util.ArrayList<User>	getEmailAddress(java.lang.String emailAddr) Returns a collection of user records that have the given email address.
java.util.ArrayList<User>	getMassEmail(boolean promos) Returns a collection of user records for the given mass email promotion flag.
int	getMassEmailCount(boolean promos) Returns the count of users for the given mass email promotion flag.
java.util.HashMap<java.lang.String,java.lang.Integer>	getMassEmailCounts() Returns the counts of users who potentially would be involved in mass email processing.
java.util.ArrayList<User>	getMatching(java.lang.String field, java.lang.String operand, java.lang.String argument) Returns a collection of user records that have a field that contains characters matching the given criteria.
java.util.ArrayList<User>	getPurge(java.util.Date asof) Returns a collection of user records that have not been accessed since the given date.
java.util.ArrayList<Customer>	getShiptoCustomers(User user) Returns a collection of all ship-to customers associated with a given user.
java.util.ArrayList<java.lang.String>	getShiptoUserIds(java.lang.String shiptoId) Returns a collection of user ids that have the specified ship-to customer assigned to them.
java.util.ArrayList<User>	getType(java.lang.String type) Returns a collection of user records for the given user type.
boolean	hasCategory(java.lang.String code) Answers if a given category code exists in the user table.
boolean	hasEmailAddress(java.lang.String emailaddr) Answers if a given email address exists in the user table.
boolean	hasSecurityProfile(java.lang.String code) Answers if a given security profile code exists in the user table.
User	valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs) Returns a database object from the given set of attributes.

Methods inherited from class com.dpslink.base.jdbc.JDBCObjectController

add, add, add, arrayToMap, arrayToMap, countAll, delete, delete, deleteAll, dispose, equals, getAll, getConnection, getConnectionInfo, getController, getFieldNames, getFieldNamesForKey, getFieldNamesForUpdate, getFieldNulls, getFieldNullsForKey, getFieldNullsForUpdate, getFieldsForOrderBy, getFieldsForWhere, getFieldSize, getFieldTypes, getFieldTypesForKey, getFieldTypesForUpdate, getStatementForDelete, getStatementForGet, getStatementForGetAll, getStatementForInsert, getStatementForUpdate, getStatementKey, getStatementString, getTableName, hasFieldNamesForKey, hasFieldNamesForUpdate, isDuplicate, resultSetToArray, resultSetToMap, resultSetToMap, resultSetToObject, setConnectionInfo, setPSDeleteValues, setPSExistsValues, setPSInsertValues, setPSUpdateValues, setPSValue, update, update

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

UserController

public UserController()

The constructor for the controller.

Method Detail

valuesToObject

public User valuesToObject(java.util.HashMap<java.lang.String,java.lang.Object> attrs)

Returns a database object from the given set of attributes. Overrides valuesToObject in JDBCObjectController.

Overrides:

valuesToObject in class JDBCObjectController<User>

Parameters:

attrs - (HashMap) The attributes to assign to the new object.

Returns:

User - An object initialized with the specified attributes.

deleteType

public boolean deleteType(java.lang.String type)

Deletes all records from the user table for the given user type. If type is User.TYPE_CUSTUSER, the default user record is recreated after delete.

Parameters:

type - (String) The type of users to be deleted. Must be one of the defined user types (i.e. User.TYPE_CUSTUSER).

Returns:

boolean - true if the deletes were successful, otherwise false.

get

public User get(java.lang.String id)

Returns the user record for the given user id.

Parameters:

id - (String) The user id for the desired record.

Returns:

User - An object initialized with values from the database.

getAllAsRS

public java.lang.Object[] getAllAsRS()

Returns a result set of all user records.

The invoker of this method is responsible for closing the returned result set and prepared statement.

Returns:

Object[] - An object array containing the result set ([0]) and the prepared statement ([1]) used to obtain the result set.

getAutoCompleteIds

public java.util.ArrayList<java.lang.String> getAutoCompleteIds(java.lang.String chars,
                                                                java.lang.String type)

Returns a collection of user ids that begin with the given characters.

Parameters:

chars - (String) The characters on which to search.

type - (String) The user type for the desired records. Must be one of the defined user types (i.e. User.TYPE_CUSTUSER).

Returns:

ArrayList - A collection of matching ids.

getBilltoUserIds

public java.util.ArrayList<java.lang.String> getBilltoUserIds(java.lang.String billtoId)

Returns a collection of user ids that have the specified bill-to customer assigned to them.

Parameters:

billtoId - (String) The bill-to customer id for the desired users.

Returns:

ArrayList - The ids of the users that have the specified bill-to customer assigned to them.

getEmailAddress

public java.util.ArrayList<User> getEmailAddress(java.lang.String emailAddr)

Returns a collection of user records that have the given email address. Excludes site administrators.

Parameters:

emailAddr - (String) The email address for the desired records.

Returns:

ArrayList - A collection of matching users.

getMassEmail

public java.util.ArrayList<User> getMassEmail(boolean promos)

Returns a collection of user records for the given mass email promotion flag. Regardless of the specified flag, only users coded as shopping users (User.TYPE_CUSTUSER) are included in the results. Duplicate email addresses are excluded. When duplicates exist, the user having the lowest ordered id is included and the others are discarded.

Parameters:

promos - (boolean) true if only users who have elected to receive promotions should be returned, otherwise false if all users are to be returned.

Returns:

ArrayList - A collection of users for the given mass email promotion flag.

getMassEmailCount

public int getMassEmailCount(boolean promos)

Returns the count of users for the given mass email promotion flag. Regardless of the specified flag, only users coded as shopping users (User.TYPE_CUSTUSER) are included in the results.

Parameters:

promos - (boolean) true if only users who have elected to receive promotions should be counted, otherwise false if all users are to be counted.

Returns:

int - The count of users for the given mass email promotion flag.

getMassEmailCounts

public java.util.HashMap<java.lang.String,java.lang.Integer> getMassEmailCounts()

Returns the counts of users who potentially would be involved in mass email processing. Only users coded as shopping users (User.TYPE_CUSTUSER) are included in the results.

Returns:

HashMap - The user counts where the key "all" is for all users and the key "promo" is for users interested in promos.

getMatching

public java.util.ArrayList<User> getMatching(java.lang.String field,
                                             java.lang.String operand,
                                             java.lang.String argument)

Returns a collection of user records that have a field that contains characters matching the given criteria.

Parameters:

field - (String) The field that is to be involved in determining the query results. This value is appended to the end of the sql properties key when obtaining the appropriate sql statement for the requested query.

operand - (String) The operation that the query is to perform on the given field in order to determine the query results. Currently only "contains" and "equals" are supported.

argument - (String) The query search argument. The character string that the query is to use in determining its results.

Returns:

ArrayList - A collection of users that match the criteria.

getPurge

public java.util.ArrayList<User> getPurge(java.util.Date asof)

Returns a collection of user records that have not been accessed since the given date.

Parameters:

asof - (java.util.Date) The cutoff date for the desired records.

Returns:

ArrayList - A collection of matching users.

getShiptoCustomers

public java.util.ArrayList<Customer> getShiptoCustomers(User user)

Returns a collection of all ship-to customers associated with a given user. Does not include deleted ship-to customers.

Parameters:

user - (User) The user for the desired ship-to customers.

Returns:

ArrayList - The active ship-to customers that are associated with the user.

getShiptoUserIds

public java.util.ArrayList<java.lang.String> getShiptoUserIds(java.lang.String shiptoId)

Returns a collection of user ids that have the specified ship-to customer assigned to them.

Parameters:

shiptoId - (String) The ship-to customer id for the desired users.

Returns:

ArrayList - The ids of the users that have the specified ship-to customer assigned to them.

getType

public java.util.ArrayList<User> getType(java.lang.String type)

Returns a collection of user records for the given user type.

Parameters:

type - (String) The user type for the desired records. Must be one of the defined user types (i.e. User.TYPE_CUSTUSER).

Returns:

ArrayList - A collection of matching users.

hasCategory

public boolean hasCategory(java.lang.String code)

Answers if a given category code exists in the user table.

Parameters:

code - (String) The category code to check.

Returns:

boolean - true if the category code exists, otherwise false.

hasEmailAddress

public boolean hasEmailAddress(java.lang.String emailaddr)

Answers if a given email address exists in the user table. Only checks shopping user email addresses (not admin or sales rep users).

Parameters:

emailaddr - (String) The email address to check.

Returns:

boolean - true if the email address exists, otherwise false.

hasSecurityProfile

public boolean hasSecurityProfile(java.lang.String code)

Answers if a given security profile code exists in the user table.

Parameters:

code - (String) The security code to check.

Returns:

boolean - true if the profile exists, otherwise false.