com.dpslink.flash.db

Class Product

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.jdbc.JDBCObject<Product>

com.dpslink.flash.db.Product

All Implemented Interfaces:

JDBCObjectKey<Product>, java.io.Serializable, java.lang.Comparable<Product>

public class Product
extends JDBCObject<Product>

Defines the fields and methods for product table objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESC_HTML The file extension for a ".html" type of description file.
static java.lang.String	DESC_TXT The file extension for a ".txt" type of description file.
static java.lang.String	IMG_GIF The file extension for a ".gif" type of image file.
static java.lang.String	IMG_JPG The file extension for a ".jpg" type of image file.
static java.lang.String	IMG_PNG The file extension for a ".png" type of image file.
private static long	serialVersionUID The class' serialization version id.
static int	SIZE_LARGE The size code for a large sized description or image file.
static int	SIZE_SMALL The size code for a small sized description or image file.
static java.lang.String	STOCKSTATUS_AVAILABLE The status code for an available stock product.
static java.lang.String	STOCKSTATUS_LOW The status code for a low stock product.
static java.lang.String	STOCKSTATUS_OUT The status code for an out of stock product.
protected static FileNameTranslator	TRANSLATOR The file name translator for description and image file names.

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

LOWVAL_RPG_DATE, LOWVAL_RPG_TIME, STATUS_ACTIVE, STATUS_BLANK, STATUS_CANCELED, STATUS_DELETED, STATUS_INACTIVE, STATUS_PENDING

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

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
Product() Constructs a Product object with all field values set to null.

Method Summary

Modifier and Type	Method and Description
int	getAvailableQty() Returns the quantity available.
int	getAvailableQty2() Returns the quantity available.
Category	getCategory(FlashServletContext ctx) Returns the default category.
java.lang.String	getCategoryCode() Returns the default category code.
java.lang.String	getClassCode() Returns the classification code.
java.lang.String	getCode() Returns the product code.
java.lang.String	getCustomerPartNumber() (not persisted) Returns the customer part number.
java.lang.String	getDescription() Returns the description.
java.io.File	getDescriptionFile(int size) Returns a file object for a product description file based on the given file size (small or large).
static java.io.File	getDescriptionFile(java.lang.String code, int size) Returns a file object for a product description file based on the given file size (small or large).
java.lang.String	getDescriptionFileContent(int size) Returns the file content for a product description file based on the given file size (small or large).
java.lang.String	getDescriptionFileContent(int size, boolean prune) Returns the file content for a product description file based on the given file size (small or large).
static java.lang.String	getDescriptionFileContent(java.lang.String code, int size) Returns the file content for a product description file based on the given file size (small or large).
static java.lang.String	getDescriptionFileContent(java.lang.String code, int size, boolean prune) Returns the file content for a product description file based on the given file size (small or large).
java.lang.String	getDescriptionRootName(int size) Returns the root name (without extension) for a product description file based on the given file size (small or large).
static java.lang.String	getDescriptionRootName(java.lang.String code, int size) Returns the root name (without extension) for a product description file based on the given file size (small or large).
java.io.File	getImageFile(int size) Returns a file object for a product image file based on the given file size (small or large).
static java.io.File	getImageFile(java.lang.String code, int size) Returns a file object for a product image file based on the given file size (small or large).
java.lang.String	getImageRootName(int size) Returns the root name (without extension) for a product image file based on the given file size (small or large).
static java.lang.String	getImageRootName(java.lang.String code, int size) Returns the root name (without extension) for a product image file based on the given file size (small or large).
java.lang.String	getImageURL(int size) Returns the relative URL for a product image file based on the given file size (small or large).
java.lang.String	getImageURL(int size, boolean full) Returns the relative or full URL for a product image file based on the given file size (small or large).
static java.lang.String	getImageURL(java.lang.String code, int size) Returns the relative URL for a product image file based on the given file size (small or large).
static java.lang.String	getImageURL(java.lang.String code, int size, boolean full) Returns the relative or full URL for a product image file based on the given file size (small or large).
Leadtime	getLeadtime() Returns the lead time object.
java.lang.String	getLeadtimeCode() Returns the lead time code.
java.math.BigDecimal	getListPrice() (not persisted) Returns the list price (price that comes from product table before any realtime information from ERP).
java.lang.String	getMfrCode() Returns the manufacturer code.
java.lang.String	getMfrPartCode() Returns the manufacturer part number.
boolean	getOnOrderFromSupplier() (not persisted) Returns the product's on order from supplier flag.
java.util.ArrayList<QuantityOnOrder>	getOnOrderFromSupplierDetail() (not persisted) Returns the product's on order from supplier detailed information.
boolean	getQtyBreakPossible() (not persisted) Returns the quantity break possible flag.
java.util.ArrayList<QuantityPriceBreak>	getQtyBreakPricing() (not persisted) Returns the collection of quantity break pricing.
boolean	getRealtimeInfoSet() (not persisted) Returns real time information set flag.
java.util.ArrayList<RelatedProductsHandler.Relationship>	getRelatedItems() (not persisted) Returns the collection of related items.
java.util.ArrayList<RelatedProductsHandler.Relationship>	getRelatedItemsForIcon() (not persisted) Returns the collection of related items for icon display purposes.
java.math.BigDecimal	getRetailPrice() Returns the unit price amount.
java.lang.Integer	getStockLowQty() Returns the low stock quantity.
java.lang.String	getStockLowQtyStr() Returns the low stock quantity.
java.lang.Integer	getStockOutQty() Returns the out of stock quantity.
java.lang.String	getStockOutQtyStr() Returns the out of stock quantity.
java.lang.String	getStockStatus() (not persisted) Returns the stock status code.
java.lang.String	getStockStatus2() (not persisted) Returns the secondary stock status code.
java.lang.String	getStockStatus2Description() (not persisted) Returns the secondary stock status description.
java.lang.String	getStockStatus2ImageURL() (not persisted) Returns the secondary stock status image URL.
java.lang.String	getStockStatus2ImageURL(boolean full) (not persisted) Returns the secondary stock status image URL.
java.lang.String	getStockStatusDescription() (not persisted) Returns the stock status description.
java.lang.String	getStockStatusImageURL() (not persisted) Returns the stock status image URL.
java.lang.String	getStockStatusImageURL(boolean full) (not persisted) Returns the stock status image URL.
UnitMeasure	getUom() Returns the unit of measure object.
java.lang.String	getUomCode() Returns the unit of measure code.
java.util.ArrayList<WarehouseQuantity>	getWarehouseQtys() (not persisted) Returns the collection of warehouse quantities.
boolean	hasDescriptionFile(int size) Answers if the product has a product-specific description file for the given file size (small or large).
static boolean	hasDescriptionFile(java.lang.String code, int size) Answers if the product has a product-specific description file for the given file size (small or large).
boolean	hasImageFile(int size) Answers if the product has a product-specific image file for the given file size (small or large).
static boolean	hasImageFile(java.lang.String code, int size) Answers if the product has a product-specific image file for the given file size (small or large).
Manufacturer	rtvMfr(FlashServletContext ctx) Retrieves Manufacturer object associated with this product.
void	rtvOnOrderFromSupplierDetail(FlashServletContext ctx) (not persisted) Retrieves supplier on-order data from the ERP system and sets the product's collection.
void	rtvQtyBreakPricing(FlashServletContext ctx) (not persisted) Retrieves quantity break pricing from the ERP system and sets the product's collection.
void	rtvWarehouseQtys(FlashServletContext ctx) (not persisted) Retrieves warehouse quantities from the ERP system and sets the product's collection.
void	setAvailableQty(int value) Sets the quantity available.
void	setAvailableQty2(int value) Sets the quantity available.
void	setCategoryCode(java.lang.String value) Sets the default category code.
void	setClassCode(java.lang.String value) Sets the classification code.
void	setCode(java.lang.String value) Sets the product code.
void	setCustomerPartNumber(java.lang.String value) (not persisted) Sets the customer part number.
void	setDescription(java.lang.String value) Sets the description.
void	setLeadtime(Leadtime value) Sets the lead time object.
private void	setLeadtimeCode(java.lang.String value) Sets the lead time code.
void	setListPrice(java.math.BigDecimal value) (not persisted) Sets the product's list price (price that comes from product table before any realtime information from ERP).
void	setMfrCode(java.lang.String value) Sets the manufacturer code.
void	setMfrPartCode(java.lang.String value) Sets the manufacturer part number.
void	setOnOrderFromSupplier(boolean value) (not persisted) Sets the product's on order from supplier flag.
void	setOnOrderFromSupplierDetail(java.util.ArrayList<QuantityOnOrder> value) (not persisted) Sets the product's on order from supplier detailed information.
void	setQtyBreakPossible(boolean value) (not persisted) Sets the quantity break possible flag.
void	setQtyBreakPricing(java.util.ArrayList<QuantityPriceBreak> value) (not persisted) Sets the collection of quantity break pricing.
void	setRealtimeInfoSet(boolean value) (not persisted) Sets the real time information set flag.
void	setRelatedItems(java.util.ArrayList<RelatedProductsHandler.Relationship> value) (not persisted) Sets the collection of related items.
void	setRelatedItemsForIcon(java.util.ArrayList<RelatedProductsHandler.Relationship> value) (not persisted) Sets the collection of related items for icon display purposes.
void	setRetailPrice(java.math.BigDecimal value) Sets the unit price amount.
void	setStockLowQty(java.lang.Integer value) Sets the low stock quantity.
void	setStockOutQty(java.lang.Integer value) Sets the out of stock quantity.
void	setStockStatus(java.lang.String value) (not persisted) Sets the stock status code.
void	setStockStatus2(java.lang.String value) (not persisted) Sets the secondary stock status code.
void	setUom(UnitMeasure value) Sets the unit of measure object.
private void	setUomCode(java.lang.String value) Sets the unit of measure code.
void	setWarehouseQtys(java.util.ArrayList<WarehouseQuantity> value) (not persisted) Sets the collection of warehouse quantities.

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

after, before, compareTo, equals, fmtStatus, fmtStatus, getObjectStatus, hashKey, setObjectStatus

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

TRANSLATOR

protected static final FileNameTranslator TRANSLATOR

The file name translator for description and image file names.

STOCKSTATUS_LOW

public static final java.lang.String STOCKSTATUS_LOW

The status code for a low stock product.

See Also:

Constant Field Values

STOCKSTATUS_OUT

public static final java.lang.String STOCKSTATUS_OUT

The status code for an out of stock product.

See Also:

Constant Field Values

STOCKSTATUS_AVAILABLE

public static final java.lang.String STOCKSTATUS_AVAILABLE

The status code for an available stock product.

See Also:

Constant Field Values

SIZE_SMALL

public static final int SIZE_SMALL

The size code for a small sized description or image file.

See Also:

Constant Field Values

SIZE_LARGE

public static final int SIZE_LARGE

The size code for a large sized description or image file.

See Also:

Constant Field Values

DESC_TXT

public static final java.lang.String DESC_TXT

The file extension for a ".txt" type of description file.

See Also:

Constant Field Values

DESC_HTML

public static final java.lang.String DESC_HTML

The file extension for a ".html" type of description file.

See Also:

Constant Field Values

IMG_GIF

public static final java.lang.String IMG_GIF

The file extension for a ".gif" type of image file.

See Also:

Constant Field Values

IMG_JPG

public static final java.lang.String IMG_JPG

The file extension for a ".jpg" type of image file.

See Also:

Constant Field Values

IMG_PNG

public static final java.lang.String IMG_PNG

The file extension for a ".png" type of image file.

See Also:

Constant Field Values

Constructor Detail

Product

public Product()

Constructs a Product object with all field values set to null.

Method Detail

getCode

public java.lang.String getCode()

Returns the product code.

Returns:

String - The product code.

setCode

public void setCode(java.lang.String value)

Sets the product code.

Parameters:

value - (String) The product code.

getDescription

public java.lang.String getDescription()

Returns the description.

Returns:

String - The description.

setDescription

public void setDescription(java.lang.String value)

Sets the description.

Parameters:

value - (String) The description.

getCategory

public Category getCategory(FlashServletContext ctx)

Returns the default category. Retrieves the category for the default code from the category table.

Parameters:

ctx - (FlashServletContext) The current servlet context.

Returns:

Category - The default category.

getCategoryCode

public java.lang.String getCategoryCode()

Returns the default category code.

Returns:

String - The default category code.

setCategoryCode

public void setCategoryCode(java.lang.String value)

Sets the default category code.

Parameters:

value - (String) The default category code.

getRetailPrice

public java.math.BigDecimal getRetailPrice()

Returns the unit price amount.

Returns:

BigDecimal - The unit price amount.

setRetailPrice

public void setRetailPrice(java.math.BigDecimal value)

Sets the unit price amount.

Parameters:

value - (BigDecimal) The unit price amount.

getListPrice

public java.math.BigDecimal getListPrice()

(not persisted) Returns the list price (price that comes from product table before any realtime information from ERP).

Returns:

BigDecimal - The list price amount.

setListPrice

public void setListPrice(java.math.BigDecimal value)

(not persisted) Sets the product's list price (price that comes from product table before any realtime information from ERP).

Parameters:

value - (BigDecimal) The list price amount.

getUom

public UnitMeasure getUom()

Returns the unit of measure object.

Returns:

UnitMeasure - The unit of measure object.

setUom

public void setUom(UnitMeasure value)

Sets the unit of measure object.

Parameters:

value - (UnitMeasure) The unit of measure object.

getUomCode

public java.lang.String getUomCode()

Returns the unit of measure code.

Returns:

String - The unit of measure code.

setUomCode

private void setUomCode(java.lang.String value)

Sets the unit of measure code.

Parameters:

value - (String) The unit of measure code.

getAvailableQty

public int getAvailableQty()

Returns the quantity available.

Returns:

int - The quantity available.

setAvailableQty

public void setAvailableQty(int value)

Sets the quantity available.

Parameters:

value - (int) The quantity available.

getAvailableQty2

public int getAvailableQty2()

Returns the quantity available.

Returns:

int - The quantity available.

setAvailableQty2

public void setAvailableQty2(int value)

Sets the quantity available.

Parameters:

value - (int) The quantity available.

getStockLowQty

public java.lang.Integer getStockLowQty()

Returns the low stock quantity.

Returns:

Integer - The low stock quantity or null if a quantity is not defined.

getStockLowQtyStr

public java.lang.String getStockLowQtyStr()

Returns the low stock quantity.

Returns:

String - The low stock quantity or an empty string if a quantity is not defined.

setStockLowQty

public void setStockLowQty(java.lang.Integer value)

Sets the low stock quantity.

Parameters:

value - (Integer) The low stock quantity or null if a quantity is not defined.

getStockOutQty

public java.lang.Integer getStockOutQty()

Returns the out of stock quantity.

Returns:

Integer - The out of stock quantity or null if a quantity is not defined.

getStockOutQtyStr

public java.lang.String getStockOutQtyStr()

Returns the out of stock quantity.

Returns:

String - The out of stock quantity or an empty string if a quantity is not defined.

setStockOutQty

public void setStockOutQty(java.lang.Integer value)

Sets the out of stock quantity.

Parameters:

value - (Integer) The out of stock quantity or null if a quantity is not defined.

getLeadtime

public Leadtime getLeadtime()

Returns the lead time object.

Returns:

Leadtime - The lead time object.

setLeadtime

public void setLeadtime(Leadtime value)

Sets the lead time object.

Parameters:

value - (Leadtime) The lead time object.

getLeadtimeCode

public java.lang.String getLeadtimeCode()

Returns the lead time code.

Returns:

String - The lead time code.

setLeadtimeCode

private void setLeadtimeCode(java.lang.String value)

Sets the lead time code.

Parameters:

value - (String) The lead time code.

getMfrPartCode

public java.lang.String getMfrPartCode()

Returns the manufacturer part number.

Returns:

String - The manufacturer part number.

setMfrPartCode

public void setMfrPartCode(java.lang.String value)

Sets the manufacturer part number.

Parameters:

value - (String) The manufacturer part number.

getMfrCode

public java.lang.String getMfrCode()

Returns the manufacturer code.

Returns:

String - The manufacturer code.

setMfrCode

public void setMfrCode(java.lang.String value)

Sets the manufacturer code.

Parameters:

value - (String) The manufacturer code.

rtvMfr

public Manufacturer rtvMfr(FlashServletContext ctx)

Retrieves Manufacturer object associated with this product.

Returns:

Manufacturer - The manufacturer or null if not found.

getClassCode

public java.lang.String getClassCode()

Returns the classification code.

Returns:

String - The classification code.

setClassCode

public void setClassCode(java.lang.String value)

Sets the classification code.

Parameters:

value - (String) The classification code.

getCustomerPartNumber

public java.lang.String getCustomerPartNumber()

(not persisted) Returns the customer part number.

Returns:

String - The customer part number.

setCustomerPartNumber

public void setCustomerPartNumber(java.lang.String value)

(not persisted) Sets the customer part number.

Parameters:

value - (String) The customer part number.

getStockStatus

public java.lang.String getStockStatus()

(not persisted) Returns the stock status code.

Returns:

String - The stock status code.

setStockStatus

public void setStockStatus(java.lang.String value)

(not persisted) Sets the stock status code.

Parameters:

value - (String) The stock status code.

getStockStatusDescription

public java.lang.String getStockStatusDescription()

(not persisted) Returns the stock status description.

Returns:

String - The stock status description.

getStockStatusImageURL

public java.lang.String getStockStatusImageURL()

(not persisted) Returns the stock status image URL.

Returns:

String - The stock status image URL.

getStockStatusImageURL

public java.lang.String getStockStatusImageURL(boolean full)

(not persisted) Returns the stock status image URL.

Parameters:

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile "Site.URL.Nonsecure".

Returns:

String - The stock status image URL.

getStockStatus2

public java.lang.String getStockStatus2()

(not persisted) Returns the secondary stock status code.

Returns:

String - The secondary stock status code.

setStockStatus2

public void setStockStatus2(java.lang.String value)

(not persisted) Sets the secondary stock status code.

Parameters:

value - (String) The secondary stock status code.

getStockStatus2Description

public java.lang.String getStockStatus2Description()

(not persisted) Returns the secondary stock status description.

Returns:

String - The secondary stock status description.

getStockStatus2ImageURL

public java.lang.String getStockStatus2ImageURL()

(not persisted) Returns the secondary stock status image URL.

Returns:

String - The secondary stock status image URL.

getStockStatus2ImageURL

public java.lang.String getStockStatus2ImageURL(boolean full)

(not persisted) Returns the secondary stock status image URL.

Parameters:

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile "Site.URL.Nonsecure".

Returns:

String - The secondary stock status image URL.

getQtyBreakPossible

public boolean getQtyBreakPossible()

(not persisted) Returns the quantity break possible flag.

Returns:

boolean - The quantity break possible flag.

setQtyBreakPossible

public void setQtyBreakPossible(boolean value)

(not persisted) Sets the quantity break possible flag.

Parameters:

value - (boolean) The quantity break possible flag.

getQtyBreakPricing

public java.util.ArrayList<QuantityPriceBreak> getQtyBreakPricing()

(not persisted) Returns the collection of quantity break pricing.

Returns:

ArrayList - The quantity break pricing or null if no quantity break pricing exists for the product.

rtvQtyBreakPricing

public void rtvQtyBreakPricing(FlashServletContext ctx)

(not persisted) Retrieves quantity break pricing from the ERP system and sets the product's collection. Retrieval is only performed if not already performed for this product (i.e. the collection is null).

Parameters:

ctx - (FlashServletContext) The current servlet context.

setQtyBreakPricing

public void setQtyBreakPricing(java.util.ArrayList<QuantityPriceBreak> value)

(not persisted) Sets the collection of quantity break pricing.

Parameters:

value - (ArrayList) The quantity break pricing.

getWarehouseQtys

public java.util.ArrayList<WarehouseQuantity> getWarehouseQtys()

(not persisted) Returns the collection of warehouse quantities.

Returns:

ArrayList - The warehouse quantities or null if no warehouse quantities exist for the product.

rtvWarehouseQtys

public void rtvWarehouseQtys(FlashServletContext ctx)

(not persisted) Retrieves warehouse quantities from the ERP system and sets the product's collection. Retrieval is only performed if not already performed for this product (i.e. the collection is null).

Parameters:

ctx - (FlashServletContext) The current servlet context.

setWarehouseQtys

public void setWarehouseQtys(java.util.ArrayList<WarehouseQuantity> value)

(not persisted) Sets the collection of warehouse quantities.

Parameters:

value - (ArrayList) The warehouse quantities.

hasDescriptionFile

public boolean hasDescriptionFile(int size)

Answers if the product has a product-specific description file for the given file size (small or large).

Parameters:

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

boolean - true if a product-specific description file exists, otherwise false.

hasDescriptionFile

public static boolean hasDescriptionFile(java.lang.String code,
                                         int size)

Answers if the product has a product-specific description file for the given file size (small or large).

Parameters:

code - (String) The product code for the desired description file.

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

boolean - true if a product-specific description file exists, otherwise false.

getDescriptionFile

public java.io.File getDescriptionFile(int size)

Returns a file object for a product description file based on the given file size (small or large). If a product-specific file does not exist, the object for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html".

Parameters:

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

File - The object for either a product-specific description file or a default description file.

getDescriptionFile

public static java.io.File getDescriptionFile(java.lang.String code,
                                              int size)

Returns a file object for a product description file based on the given file size (small or large). If a product-specific file does not exist, the object for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html".

Parameters:

code - (String) The product code for the desired description file.

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

File - The object for either a product-specific description file or a default description file.

getDescriptionFileContent

public java.lang.String getDescriptionFileContent(int size)

Returns the file content for a product description file based on the given file size (small or large). If a product-specific file does not exist, the content for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html". Assumes the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Parameters:

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The content for either a product-specific description file or a default description file.

getDescriptionFileContent

public static java.lang.String getDescriptionFileContent(java.lang.String code,
                                                         int size)

Returns the file content for a product description file based on the given file size (small or large). If a product-specific file does not exist, the content for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html". Assumes the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Parameters:

code - (String) The product code for the desired description file.

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The content for either a product-specific description file or a default description file.

getDescriptionFileContent

public java.lang.String getDescriptionFileContent(int size,
                                                  boolean prune)

Returns the file content for a product description file based on the given file size (small or large). If a product-specific file does not exist, the content for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html".

Parameters:

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

prune - (boolean) true if the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The content for either a product-specific description file or a default description file.

getDescriptionFileContent

public static java.lang.String getDescriptionFileContent(java.lang.String code,
                                                         int size,
                                                         boolean prune)

Returns the file content for a product description file based on the given file size (small or large). If a product-specific file does not exist, the content for a default description file is returned. When determining the description file's name, this method first tries ".txt" as the file extension and then tries ".html".

Parameters:

code - (String) The product code for the desired description file.

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

prune - (boolean) true if the content is to be pruned by invoking the TemplatePruner class to remove potentially harmful html code.

Returns:

String - The content for either a product-specific description file or a default description file.

getDescriptionRootName

public java.lang.String getDescriptionRootName(int size)

Returns the root name (without extension) for a product description file based on the given file size (small or large). A root name is a code that has been translated and made valid for the file system.

Parameters:

size - (int) The size of the desired description file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The root file name.

getDescriptionRootName

public static java.lang.String getDescriptionRootName(java.lang.String code,
                                                      int size)

Returns the root name (without extension) for a product description file based on the given file size (small or large). A root name is a code that has been translated and made valid for the file system.

Parameters:

code - (String) The product code for the desired description file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The root file name.

hasImageFile

public boolean hasImageFile(int size)

Answers if the product has a product-specific image file for the given file size (small or large).

Parameters:

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

boolean - true if a product-specific image file exists, otherwise false.

hasImageFile

public static boolean hasImageFile(java.lang.String code,
                                   int size)

Answers if the product has a product-specific image file for the given file size (small or large).

Parameters:

code - (String) The product code for the desired image file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

boolean - true if a product-specific image file exists, otherwise false.

getImageFile

public java.io.File getImageFile(int size)

Returns a file object for a product image file based on the given file size (small or large). If a product-specific file does not exist, the object for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

File - The object for either a product-specific image file or a default image file.

getImageFile

public static java.io.File getImageFile(java.lang.String code,
                                        int size)

Returns a file object for a product image file based on the given file size (small or large). If a product-specific file does not exist, the object for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The product code for the desired image file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

File - The object for either a product-specific image file or a default image file.

getImageRootName

public java.lang.String getImageRootName(int size)

Returns the root name (without extension) for a product image file based on the given file size (small or large). A root name is a code that has been translated and made valid for the file system.

Parameters:

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The root file name.

getImageRootName

public static java.lang.String getImageRootName(java.lang.String code,
                                                int size)

Returns the root name (without extension) for a product image file based on the given file size (small or large). A root name is a code that has been translated and made valid for the file system.

Parameters:

code - (String) The product code for the desired image file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The root file name.

getImageURL

public java.lang.String getImageURL(int size)

Returns the relative URL for a product image file based on the given file size (small or large). If a product-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The relative URL for either a product-specific image file or a default image file.

getImageURL

public static java.lang.String getImageURL(java.lang.String code,
                                           int size)

Returns the relative URL for a product image file based on the given file size (small or large). If a product-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The product code for the desired image file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

Returns:

String - The relative URL for either a product-specific image file or a default image file.

getImageURL

public java.lang.String getImageURL(int size,
                                    boolean full)

Returns the relative or full URL for a product image file based on the given file size (small or large). If a product-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - The relative or full URL for either a product-specific image file or a default image file.

getImageURL

public static java.lang.String getImageURL(java.lang.String code,
                                           int size,
                                           boolean full)

Returns the relative or full URL for a product image file based on the given file size (small or large). If a product-specific file does not exist, the URL for a default image file is returned. When determining the image file's name, this method first tries ".jpg" as the file extension and then tries ".png" and then tries ".gif".

Parameters:

code - (String) The product code for the desired image file.

size - (int) The size of the desired image file. Must be one of the defined size constants (SIZE_SMALL, SIZE_LARGE).

full - (boolean) true to return the fully qualified URL or false to return the relative URL. The fully qualified URL is per Profile.BASE_URL_NONSECURE.

Returns:

String - The relative or full URL for either a product-specific image file or a default image file.

getRealtimeInfoSet

public boolean getRealtimeInfoSet()

(not persisted) Returns real time information set flag.

Returns:

boolean - The real time set flag.

setRealtimeInfoSet

public void setRealtimeInfoSet(boolean value)

(not persisted) Sets the real time information set flag.

Parameters:

value - (boolean) The real time set flag.

getOnOrderFromSupplier

public boolean getOnOrderFromSupplier()

(not persisted) Returns the product's on order from supplier flag.

Returns:

boolean - The product's on order from supplier flag.

setOnOrderFromSupplier

public void setOnOrderFromSupplier(boolean value)

(not persisted) Sets the product's on order from supplier flag.

Parameters:

value - (boolean) The product's on order from supplier flag.

getOnOrderFromSupplierDetail

public java.util.ArrayList<QuantityOnOrder> getOnOrderFromSupplierDetail()

(not persisted) Returns the product's on order from supplier detailed information.

Returns:

ArrayList - The product's on order from supplier information.

rtvOnOrderFromSupplierDetail

public void rtvOnOrderFromSupplierDetail(FlashServletContext ctx)

(not persisted) Retrieves supplier on-order data from the ERP system and sets the product's collection. Retrieval is only performed if not already performed for this product (i.e. the collection is null).

Parameters:

ctx - (FlashServletContext) The current servlet context.

setOnOrderFromSupplierDetail

public void setOnOrderFromSupplierDetail(java.util.ArrayList<QuantityOnOrder> value)

(not persisted) Sets the product's on order from supplier detailed information.

Parameters:

value - (ArrayList) The product's on order from supplier information.

getRelatedItems

public java.util.ArrayList<RelatedProductsHandler.Relationship> getRelatedItems()

(not persisted) Returns the collection of related items.

Returns:

ArrayList - The related items or null if related items have not yet been retrieved for the product.

setRelatedItems

public void setRelatedItems(java.util.ArrayList<RelatedProductsHandler.Relationship> value)

(not persisted) Sets the collection of related items.

Parameters:

value - (ArrayList) The related items.

getRelatedItemsForIcon

public java.util.ArrayList<RelatedProductsHandler.Relationship> getRelatedItemsForIcon()

(not persisted) Returns the collection of related items for icon display purposes.

Returns:

ArrayList - The related items or null if related items have not yet been retrieved for the product.

setRelatedItemsForIcon

public void setRelatedItemsForIcon(java.util.ArrayList<RelatedProductsHandler.Relationship> value)

(not persisted) Sets the collection of related items for icon display purposes.

Parameters:

value - (ArrayList) The related items.