com.dpslink.flash.db.util

Class UserFavoritesHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.UserFavoritesHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class UserFavoritesHandler
extends DBUHandler

A handler for user favorites and associated favorites descriptor processing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FAVORITE_ID_PREFIX The prefix used for generated favorite cart ids.
private static long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SN_FAVORITE_CART The session's key for the shopping users current favorites cart.
protected static java.lang.String	SN_FAVORITE_DESC The session's key for the shopping users current favorites descriptors.

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

ivContext

Constructor Summary

Constructors

Constructor and Description
UserFavoritesHandler() Constructs a new instance of the user favorites handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
boolean	addList(FavoritesDescriptor fd) Addes a new favorites list for the shopping user and then makes the new list the shopping user's current favorites list.
boolean	copyList(FavoritesDescriptor fd, User user) Copies an existing favorites list from one user to another.
Cart	createNewCart() Creates a new favorites cart and persists it to the database.
Cart	createNewList(User user, java.lang.String description) Creates a new favorites list for a user.
boolean	deleteList() Deletes the current favorites list for the shopping user and then makes the first available existing list the shopping user's current favorites list.
Cart	getCart() Returns the shopping user's current favorites cart.
java.util.TreeSet<FavoritesDescriptor>	getDescriptors() Returns the shopping user's current set of favorites descriptors.
java.lang.String	getListId() Returns the shopping user's current favorites list id.
Select	getListUISelect(java.lang.String id) Returns an HTML Select object of the shopping user's favorites lists with the given id preselected in the set of options.
boolean	setListId(java.lang.String id) Sets the shopping user's favorites list id to the given id.
void	setSessionValues(User user) Sets the session object in the current servlet context with the favorites information for a user.
boolean	updateList(FavoritesDescriptor fd) Updates the current favorites list for the shopping user.

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

getContext, setContext

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

FAVORITE_ID_PREFIX

public static final java.lang.String FAVORITE_ID_PREFIX

The prefix used for generated favorite cart ids.

See Also:

Constant Field Values

SN_FAVORITE_CART

protected static final java.lang.String SN_FAVORITE_CART

The session's key for the shopping users current favorites cart.

See Also:

Constant Field Values

SN_FAVORITE_DESC

protected static final java.lang.String SN_FAVORITE_DESC

The session's key for the shopping users current favorites descriptors.

See Also:

Constant Field Values

Constructor Detail

UserFavoritesHandler

public UserFavoritesHandler()

Constructs a new instance of the user favorites handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

addList

public boolean addList(FavoritesDescriptor fd)

Addes a new favorites list for the shopping user and then makes the new list the shopping user's current favorites list.

Parameters:

fd - (FavoritesDescriptor) A descriptor that contains the list data to add.

Returns:

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

deleteList

public boolean deleteList()

Deletes the current favorites list for the shopping user and then makes the first available existing list the shopping user's current favorites list.

Returns:

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

updateList

public boolean updateList(FavoritesDescriptor fd)

Updates the current favorites list for the shopping user.

Parameters:

fd - (FavoritesDescriptor) A descriptor that contains the list data to update.

Returns:

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

getCart

public Cart getCart()

Returns the shopping user's current favorites cart.

Returns:

Cart - The favorites cart or null if there currently is no favorites cart.

getDescriptors

public java.util.TreeSet<FavoritesDescriptor> getDescriptors()

Returns the shopping user's current set of favorites descriptors.

Returns:

TreeSet - The favorites descriptors.

getListId

public java.lang.String getListId()

Returns the shopping user's current favorites list id.

Returns:

String - The current favorites list id.

setListId

public boolean setListId(java.lang.String id)

Sets the shopping user's favorites list id to the given id. A switch in ids is only performed if the specified id is different than the current id.

Parameters:

id - (String) The id of the favorites list to set.

Returns:

boolean - true if the id is successfully set, otherwise false.

getListUISelect

public Select getListUISelect(java.lang.String id)

Returns an HTML Select object of the shopping user's favorites lists with the given id preselected in the set of options. Invokers must assign a form field name to the returned object via the setName method before adding the object to the velocity template data.

Parameters:

id - (String) The descriptor id to preselect in the select's set of options. Pass an empty string for this parameter if a blank option is to be created as the first option and then preselected. Pass a null for this parameter if no blank option and no preselecting is desired.

Returns:

Select - An HTML Select object.

setSessionValues

public void setSessionValues(User user)

Sets the session object in the current servlet context with the favorites information for a user.

NOTE: The user supplied here must either be the current shopping user or a user who is about to become the current shopping user. All methods in this class that do not have a user parameter are based on the current shopping user.

Parameters:

user - (User) The user whose favorite information should be set or null to nullify the session's favorites information.

createNewCart

public Cart createNewCart()

Creates a new favorites cart and persists it to the database.

Returns:

Cart - The new favorites cart or null if the new cart could not be created.

createNewList

public Cart createNewList(User user,
                          java.lang.String description)

Creates a new favorites list for a user.

• Creates a new favorites cart object and an associated favorites descriptor object.
• Persists the new favorites cart and favorites descriptor to the database.

Parameters:

user - (User) The user who owns the new favorite.

description - (String) The description for the favorite.

Returns:

Cart - The new favorites cart or null if the new cart could not be created.

copyList

public boolean copyList(FavoritesDescriptor fd,
                        User user)

Copies an existing favorites list from one user to another. This method does everything necessary to create the new favorite list including:

• Creates a new favorites cart object and an associated favorites descriptor object.
• Persists the new cart and favorites descriptor to the database.
• Copies cart lines from the existing favorite to the new favorite.

NOTE: If copying to an existing favorite (the copy-to description is the same as the copy-from description), no new cart or descriptor objects are created; the existing copy-to objects are used. In this case, the copy-to favorite's cart lines are deleted before the copying occurs (i.e. there is no merging of cart lines; the copy-to favorite cart lines are replaced.

Parameters:

fd - (FavoritesDescriptor) The favorites list to copy from.

user - (User) The user who owns the new favorites being copied to.

Returns:

boolean - true if the copying is successful, otherwise false.