com.dpslink.flash.db.util

Class UserCatalogVerifier

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.UserCatalogVerifier

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class UserCatalogVerifier
extends DBUHandler

A helper class that handles verification of products in a user's catalog and in a user's set of permits.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private UserCatalog	ivCatalog The catalog of products and categories used during verification.
private java.lang.String[]	ivCategories A string array of the category codes in the user's catalog.
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
UserCatalogVerifier() Constructs a new instance of the user catalog verifier with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
boolean	isProductInCatalog(Product product) Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.
boolean	isProductInCatalog(java.lang.String prodcode) Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.
boolean	isProductInCatalog(java.lang.String prodcode, java.lang.String uomcode) Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.
boolean	isProductInCategory(Product product, java.lang.String catcode) Answers if a product is in the user's catalog and in the given category within the catalog and, if permit processing is active, determines if the product is in the user's set of permits.
boolean	isProductInCategory(java.lang.String prodcode, java.lang.String uomcode, java.lang.String catcode) Answers if a product is in the user's catalog and in the given category within the catalog and, if permit processing is active, determines if the product is in the user's set of permits.
private void	loadCategories() Loads the ivCategories instance variable with the category codes in the user's catalog.
void	setContext(FlashServletContext ctx) Sets the class' servlet context (i.e.
void	verifyCartLines(Cart cart) Verifies that each product within the given cart's set of cart lines is in the user's catalog and/or in the user's set of permits.
java.util.ArrayList<Product>	verifyProducts(java.util.ArrayList<Product> products) Verifies that each product within the given collection of products is in the user's catalog and/or in the user's set of permits and returns a collection that contains only the products that pass the verification.

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

ivCatalog

private UserCatalog ivCatalog

The catalog of products and categories used during verification.

ivCategories

private java.lang.String[] ivCategories

A string array of the category codes in the user's catalog.

Constructor Detail

UserCatalogVerifier

public UserCatalogVerifier()

Constructs a new instance of the user catalog verifier 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.

isProductInCatalog

public boolean isProductInCatalog(Product product)

Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.

Parameters:

product - (Product) The product to verify.

Returns:

boolean - true if the product is a valid product in the user's catalog and/or in the user's set of permits, otherwise false.

isProductInCatalog

public boolean isProductInCatalog(java.lang.String prodcode)

Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.

Parameters:

prodcode - (String) The product code to verify.

Returns:

boolean - true if the product is a valid product in the user's catalog and/or in the user's set of permits, otherwise false.

isProductInCatalog

public boolean isProductInCatalog(java.lang.String prodcode,
                                  java.lang.String uomcode)

Answers if a product is in the user's catalog and, if permit processing is active, determines if the product is in the user's set of permits.

Parameters:

prodcode - (String) The product code to verify.

uomcode - (String) The unit of measure code to verify.

Returns:

boolean - true if the product is a valid product in the user's catalog and/or in the user's set of permits, otherwise false.

isProductInCategory

public boolean isProductInCategory(Product product,
                                   java.lang.String catcode)

Answers if a product is in the user's catalog and in the given category within the catalog and, if permit processing is active, determines if the product is in the user's set of permits.

Parameters:

product - (Product) The product to verify.

catcode - (String) The category code to verify.

Returns:

boolean - true if the product is a valid product in the user's catalog and/or in the user's set of permits, otherwise false.

isProductInCategory

public boolean isProductInCategory(java.lang.String prodcode,
                                   java.lang.String uomcode,
                                   java.lang.String catcode)

Answers if a product is in the user's catalog and in the given category within the catalog and, if permit processing is active, determines if the product is in the user's set of permits.

Parameters:

prodcode - (String) The product code to verify.

uomcode - (String) The unit of measure code to verify.

catcode - (String) The category code to verify.

Returns:

boolean - true if the product is a valid product in the user's catalog and/or in the user's set of permits, otherwise false.

loadCategories

private void loadCategories()

Loads the ivCategories instance variable with the category codes in the user's catalog.

verifyCartLines

public void verifyCartLines(Cart cart)

Verifies that each product within the given cart's set of cart lines is in the user's catalog and/or in the user's set of permits. Cart lines having products that do not pass the verification are deleted. No verification is performed if the user is the default user (User.DEFAULT_USER) or the site administrator (User.TYPE_SITEADMIN).

Parameters:

cart - (Cart) The cart (shopping cart or favorite items) that owns the cart lines that are to be verified.

verifyProducts

public java.util.ArrayList<Product> verifyProducts(java.util.ArrayList<Product> products)

Verifies that each product within the given collection of products is in the user's catalog and/or in the user's set of permits and returns a collection that contains only the products that pass the verification. All products in the given collection are considered valid when the user is the site administrator (User.TYPE_SITEADMIN).

Parameters:

products - (ArrayList) The set of products to be verified.

Returns:

ArrayList - The set of products that pass verification.