com.dpslink.flash.db.util

Class UnitMeasureHandler

java.lang.Object

com.dpslink.flash.db.util.DBUHandler

com.dpslink.flash.db.util.UnitMeasureHandler

All Implemented Interfaces:

DBUInterface, java.io.Serializable

public class UnitMeasureHandler
extends DBUHandler

Handles specialized processing for product units of measure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UnitMeasureHandler.MultiPriceBreak Inner class that defines multiple uom quantity price break data.

Field Summary

Fields

Modifier and Type	Field and Description
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
UnitMeasureHandler() Constructs a new instance of the unit of measure handler with a null servlet or thread context.

Method Summary

Modifier and Type	Method and Description
static void	fillOrderAuditLine(OrderAuditLine oal, CartLine cartline) Fills an order audit line's values using values from the given cart line.
protected java.lang.String	formatPrice(java.math.BigDecimal value) Returns a formatted price string.
protected java.lang.String	formatQuantity(int value) Returns a formatted quantity string.
protected UnitMeasure	getDefaultOrderUom(Product product) Returns the default order unit of measure for the given product.
protected UnitMeasure	getDefaultPriceUom(Product product) Returns the default price unit of measure for the given product based on the product's quantity price break data from the ERP system.
protected java.util.ArrayList<QuantityPriceBreak>	getQuantityBreaks(Product product) Returns a collection of quantity price breaks for the given product.
protected java.util.ArrayList<QuantityPriceBreak>	getSortedPriceUoms(CartLine cartline, boolean incldescr) Returns a sorted list of unique price units of measure for the given cart line.
protected java.util.ArrayList<QuantityPriceBreak>	getSortedUniqueUoms(Product product, java.lang.String uomtype, boolean incldescr) Returns a sorted list of unique units of measure for the given product and unit of measure type (order, price).
protected Select	getTemplateOrderUoms(Product product, java.lang.String selectuom, boolean showdescr) Returns an HTML Select object that contains the given product's selectable order units of measure.
protected Select	getTemplatePriceUoms(CartLine cartline, java.lang.String selectuom, boolean showdescr, boolean showprice) Returns an HTML Select object that contains the given cart line's selectable price units of measure.
protected Select	getTemplatePriceUoms(Product product, java.lang.String selectuom, boolean showdescr, boolean showprice) Returns an HTML Select object that contains the given product's selectable price units of measure.
protected void	setCartLinePrices(CartLine cartline) Sets the order and price unit of measure prices for the given cart line.
void	setCartLineTemplateUoms(java.util.ArrayList<CartLine> cartlines) Sets the unit of measure html template data for a group of cart lines.
void	setCartLineUoms(java.util.ArrayList<CartLine> cartlines) Sets the unit of measure and price values for a group of cart lines.
void	setCartLineUoms(CartLine cartline) Sets the unit of measure and price values for a given cart line.
void	setCartLineUoms(CartLine cartline, java.lang.String orderuom, java.lang.String priceuom) Sets the unit of measure and price values for a given cart line.
boolean	setTemplateQuantityBreaks() Sets the quantity price break html template data for the given product.

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

Constructor Detail

UnitMeasureHandler

public UnitMeasureHandler()

Constructs a new instance of the unit of measure handler with a null servlet or thread context.

A CONTEXT MUST BE SET BEFORE INVOKING ANY OTHER METHODS.

.

Method Detail

fillOrderAuditLine

public static void fillOrderAuditLine(OrderAuditLine oal,
                                      CartLine cartline)

Fills an order audit line's values using values from the given cart line.

Invoked by the OrderAudit class when adding a new order audit line to the database. Nothing should be placed in this method that requires use of the current servlet context.

Parameters:

oal - (OrderAuditLine) The order audit line to be filled.

cartline - (CartLine) The cart line to use for filling the line.

getDefaultOrderUom

protected UnitMeasure getDefaultOrderUom(Product product)

Returns the default order unit of measure for the given product. Currently returns the product's unit of measure as the default (i.e. the product's assigned unit of measure in the product table).

Parameters:

product - (Product) The product for the desired order unit of measure.

Returns:

UnitMeasure - The specified product's default order unit of measure.

getDefaultPriceUom

protected UnitMeasure getDefaultPriceUom(Product product)

Returns the default price unit of measure for the given product based on the product's quantity price break data from the ERP system.

Parameters:

product - (Product) The product for the desired price unit of measure.

Returns:

UnitMeasure - The specified product's default price unit of measure. If a default cannot be determined, the product's default order unit of measure is returned.

getQuantityBreaks

protected java.util.ArrayList<QuantityPriceBreak> getQuantityBreaks(Product product)

Returns a collection of quantity price breaks for the given product. Retrieves the product's quantity price breaks from the backend if they have not yet been retrieved.

Parameters:

product - (Product) The product for the desired qty price breaks.

Returns:

ArrayList - The qty price breaks for the specified product.

getSortedPriceUoms

protected java.util.ArrayList<QuantityPriceBreak> getSortedPriceUoms(CartLine cartline,
                                                                     boolean incldescr)

Returns a sorted list of unique price units of measure for the given cart line. The value for each item in the list is the quantity price break for the cart line's quantity.

Parameters:

cartline - (CartLine) The cart line for the desired unit of measure data.

incldescr - (boolean) true if uom descriptions are to be included, otherwise false.

Returns:

ArrayList - A sorted list of unique price units of measure for the given cart line.

getSortedUniqueUoms

protected java.util.ArrayList<QuantityPriceBreak> getSortedUniqueUoms(Product product,
                                                                      java.lang.String uomtype,
                                                                      boolean incldescr)

Returns a sorted list of unique units of measure for the given product and unit of measure type (order, price). The value for each item in the list is the first quantity price break encountered for each code.

Parameters:

product - (Product) The product for the desired unit of measure data.

uomtype - (String) The type of units of measure to put in the list. Valid values are "order" and "price".

incldescr - (boolean) true if uom descriptions are to be included, otherwise false.

Returns:

ArrayList - A sorted list of unique units of measure for the given product and unit of measure type.

getTemplateOrderUoms

protected Select getTemplateOrderUoms(Product product,
                                      java.lang.String selectuom,
                                      boolean showdescr)

Returns an HTML Select object that contains the given product's selectable order units of measure. 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:

product - (Product) The product for the desired order unit of measure data.

selectuom - (String) The code for the unit of measure that is to be flagged as the selected unit of measure. null indicates that the product's default order unit of measure is to be flagged.

showdescr - (boolean) true if uom descriptions are to be shown, otherwise false.

Returns:

Select - An HTML Select object..

getTemplatePriceUoms

protected Select getTemplatePriceUoms(CartLine cartline,
                                      java.lang.String selectuom,
                                      boolean showdescr,
                                      boolean showprice)

Returns an HTML Select object that contains the given cart line's selectable price units of measure. 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:

cartline - (Cartline) The cart line for the desired price unit of measure data.

selectuom - (String) The code for the unit of measure that is to be flagged as the selected unit of measure. null indicates that the product's default price unit of measure is to be flagged.

showdescr - (boolean) true if uom descriptions are to be shown, otherwise false.

showprice - (boolean) true if prices are to be shown, otherwise false.

Returns:

Select - An HTML Select object..

getTemplatePriceUoms

protected Select getTemplatePriceUoms(Product product,
                                      java.lang.String selectuom,
                                      boolean showdescr,
                                      boolean showprice)

Returns an HTML Select object that contains the given product's selectable price units of measure. 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:

product - (Product) The product for the desired price unit of measure data.

selectuom - (String) The code for the unit of measure that is to be flagged as the selected unit of measure. null indicates that the product's default price unit of measure is to be flagged.

showdescr - (boolean) true if uom descriptions are to be shown, otherwise false.

showprice - (boolean) true if prices are to be shown, otherwise false.

Returns:

Select - An HTML Select object..

setCartLinePrices

protected void setCartLinePrices(CartLine cartline)

Sets the order and price unit of measure prices for the given cart line.

Invoked by the setCartLineUoms method below when setting uom values for cart lines that are being processed for realtime info or for cart lines that are being added or updated to a cart object.

Parameters:

cartline - (CartLine) The cart line that is to have its values set.

setCartLineUoms

public void setCartLineUoms(CartLine cartline)

Sets the unit of measure and price values for a given cart line.

Invoked by the setCartLineUoms method below when setting uom values for cart lines that are being processed for realtime info.

Invoked by the CartLine class to set the uom values for cart lines that are being added or updated to a cart object.

Parameters:

cartline - (CartLine) The cart line that is to have its values set.

setCartLineUoms

public void setCartLineUoms(CartLine cartline,
                            java.lang.String orderuom,
                            java.lang.String priceuom)

Sets the unit of measure and price values for a given cart line.

Invoked by the CartLine class to set the uom values for cart lines that are being retrieved from the database.

Parameters:

cartline - (CartLine) The cart line that is to have its values set.

orderuom - (String) The order unit of measure code from the cart line's record in the database.

priceuom - (String) The price unit of measure code from the cart line's record in the database.

setCartLineUoms

public void setCartLineUoms(java.util.ArrayList<CartLine> cartlines)

Sets the unit of measure and price values for a group of cart lines.

Invoked by the CartLine class to set the uom values for cart lines that are being processed for realtime info.

Parameters:

cartlines - (ArrayList) The cart lines that are to have their values set.

setCartLineTemplateUoms

public void setCartLineTemplateUoms(java.util.ArrayList<CartLine> cartlines)

Sets the unit of measure html template data for a group of cart lines. The html template data being set is an html Select object for each cart line product's selectable order and price units of measure.

Invoked by ReviewCart and FavoriteItems to set the uom template data for cart lines that are being displayed on the page.

The Velocity variables used by the template should be:

• $CartLine.getOrderUomSelect() - the order unit of measure select object. The submitted form field name is OrderUnits.
• $CartLine.getPriceUomSelect() - the price unit of measure select object. The submitted form field name is PriceUnits.

Parameters:

cartlines - (ArrayList) The cart lines that are to have their html template data set.

setTemplateQuantityBreaks

public boolean setTemplateQuantityBreaks()

Sets the quantity price break html template data for the given product.

Invoked by the ProductDetails class to set html template data for the product being displayed on the page.

The Velocity variables used by the template should be:

• $QuantityBreakList - the list of quantity price breaks. This will be an ArrayList of QuantityPriceBreak objects when multiple units of measure is not active or an ArrayList of MultiPriceBreak objects when multiple units of measure is active.
• $OrderUnits - the order unit of measure select object. The submitted form field name is OrderUnits.
• $PriceUnits - the price unit of measure select object. The submitted form field name is PriceUnits.

Returns:

boolean - true if the product has quantity breaks and the template data is successfully set. false if the product does not have quantity breaks or if the template data could not be set.

formatQuantity

protected java.lang.String formatQuantity(int value)

Returns a formatted quantity string.

Parameters:

value - (int) The quantity to format.

Returns:

String - The formatted quantity.

formatPrice

protected java.lang.String formatPrice(java.math.BigDecimal value)

Returns a formatted price string.

Parameters:

value - (BigDecimal) The price to format.

Returns:

String - The formatted price.