Open Source Enterprise Content Management for the Enterprise

A proven framework for building great web sites

Search:

OpenEdit Software OpenEdit User Group OpenEdit Services English Español

OpenEdit Software

Download Feature Matrix Video Tutorials Screenshots OpenEdit Demo Documentation

OpenEdit User Group

User Forum OpenEdit Blog Who is using OpenEdit? OE Project Tracker

OpenEdit Services

Software Consulting Hosting Contact Us

org.openedit.store
Class Product

java.lang.Object
  org.openedit.store.Product

public class Product
extends java.lang.Object

Author:

cburkey

Constructor Summary

Product()

Product(java.lang.String inName)

Method Summary

void	addCatalog(Category inCatid)
void	addCategory(Category inCatid)
void	addInventoryItem(InventoryItem inItem)
void	addKeyword(java.lang.String inString)
void	addOption(Option inOption)
void	addProperty(java.lang.String inKey, java.lang.String inValue) Deprecated. use setProperty
void	addRelatedFile(RelatedFile file)
void	addRelatedProduct(RelatedProduct inRelationship)
void	addTierPrice(int inQuantity, Price inPrice)
void	clearCatalogs()
void	clearItems()
void	clearKeywords()
void	clearOptions()
void	clearRelatedFiles()
void	clearRelatedProducts()
void	clearUserCatalogs()
java.util.List	colorsInSize(Option inSize) List all the colors available in this size
Product	copy()
Product	copy(java.lang.String newId)
java.lang.String	get(java.lang.String inAttribute) This will look in all the category objects if needed
java.util.List	getAllOptions()
java.util.List	getCatalogs() Deprecated.
java.util.List	getCategories()
InventoryItem	getCloseInventoryItemByOptions(java.util.Set inOptions)
java.util.List	getColors()
java.util.Date	getDate(java.lang.String inField, java.lang.String inDateFormat)
Category	getDefaultCatalog() Deprecated. Use getDefaultCategory instead.
Category	getDefaultCategory()
Option	getDefaultColor()
Option	getDefaultSize()
java.lang.String	getDeliveryType()
java.lang.String	getDepartment()
java.lang.String	getDescription()
java.lang.String	getHandlingChargeLevel()
java.lang.String	getId()
InventoryItem	getInventoryItem(int inI)
InventoryItem	getInventoryItemByOptions(java.util.Collection inOptions)
InventoryItem	getInventoryItemBySku(java.lang.String inSku)
int	getInventoryItemCount()
java.util.List	getInventoryItems()
java.util.List	getKeywords()
java.lang.String	getName()
Option	getOption(java.lang.String inOptionId)
java.util.List	getOptions()
int	getOrdering()
PriceSupport	getPriceSupport()
java.lang.String	getPrimaryImagePath()
RelatedFile	getPrimaryRelatedFile()
java.util.Map	getProperties()
java.lang.String	getProperty(java.lang.String inKey)
java.util.Collection	getRelatedCatalogs()
java.util.List	getRelatedFiles()
java.util.List	getRelatedProducts()
java.util.List	getRelatedProducts(java.lang.String inType)
org.openedit.money.Money	getRetailPrice()
org.openedit.money.Money	getRetailUnitPrice()
java.lang.String	getSaveAsName()
java.lang.String	getShippingMethodId()
java.lang.String	getShortDescription() This is an optional field
java.util.List	getSizes()
java.util.List	getSizesSorted()
Page	getSourcePage()
java.lang.String	getSourcePath()
org.openedit.money.Money	getYourPrice()
boolean	hasColor()
boolean	hasColors()
boolean	hasKeywords()
boolean	hasProductLevelPricing()
boolean	hasProperty(java.lang.String inKey)
boolean	hasRelatedFiles()
boolean	hasRelatedProducts()
boolean	hasSize()
boolean	hasSizes()
void	incrementProperty(java.lang.String property, int delta)
boolean	isAvailable()
boolean	isCustomPrice()
boolean	isInCatalog(Category inCategory)
boolean	isInCategory(Category inCat)
boolean	isInCategory(java.lang.String inCategoryId)
boolean	isInStock()
boolean	isOnSale()
boolean	isPartlyOutOfStock()
boolean	isRelated(RelatedProduct inId)
boolean	isRelated(java.lang.String inString)
boolean	isTaxExempt()
void	putAttribute(java.lang.String inKey, java.lang.String inValue)
void	removeCatalog(Category inCatid) Deprecated. use removeCategory instead.
void	removeCategory(Category inCategory)
void	removeKeyword(java.lang.String inKey)
void	removeOption(java.lang.String id)
void	removeProperty(java.lang.String inKey)
void	removeRelatedProduct(java.lang.String productid)
void	setAvailable(boolean inAvailable)
void	setCategories(java.util.List inCatalogs)
void	setCustomPrice(boolean inCustomPrice)
void	setDefaultCatalog(Category inDefaultCatalog) Deprecated. use setDefaultCategory instead.
void	setDefaultCategory(Category inDefaultCategory)
void	setDeliveryType(java.lang.String inDeliveryType)
void	setDepartment(java.lang.String fieldDepartment)
void	setDescription(java.lang.String inDescription)
void	setHandlingChargeLevel(java.lang.String inHandlingChargeLevel)
void	setId(java.lang.String inString)
void	setInventoryItems(java.util.List inItems)
void	setKeywords(java.util.List inKeywords)
void	setName(java.lang.String inName)
void	setOptions(java.util.List inOptions)
void	setOrdering(int inOrdering)
void	setOriginalImagePath(java.lang.String inPath)
void	setPriceSupport(PriceSupport priceSupport)
void	setProperties(java.util.Map inAttributes)
void	setProperty(java.lang.String inKey, java.lang.String inValue)
void	setRelatedFiles(java.util.List relatedFiles)
void	setRelatedProducts(java.util.List inRelatedProducts)
void	setShippingMethodId(java.lang.String inShippingMethodId)
void	setShortDescription(java.lang.String inDescription)
void	setSourcePage(Page inSourcePage)
void	setSourcePath(java.lang.String inSourcePath)
void	setTaxExempt(boolean inTaxExempt)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Product

public Product()

Product

public Product(java.lang.String inName)

Method Detail

getRelatedFiles

public java.util.List getRelatedFiles()

setRelatedFiles

public void setRelatedFiles(java.util.List relatedFiles)

getOrdering

public int getOrdering()

setOrdering

public void setOrdering(int inOrdering)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String inName)

getShortDescription

public java.lang.String getShortDescription()

This is an optional field

Returns:

setShortDescription

public void setShortDescription(java.lang.String inDescription)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public java.lang.String getId()

setId

public void setId(java.lang.String inString)

get

public java.lang.String get(java.lang.String inAttribute)

This will look in all the category objects if needed

addProperty

public void addProperty(java.lang.String inKey,
                        java.lang.String inValue)

Deprecated. use setProperty

Parameters:

inValue -

removeProperty

public void removeProperty(java.lang.String inKey)

addCatalog

public void addCatalog(Category inCatid)

Parameters:

inCatid -

addCategory

public void addCategory(Category inCatid)

removeCatalog

public void removeCatalog(Category inCatid)

Deprecated. use removeCategory instead.

removeCategory

public void removeCategory(Category inCategory)

getCatalogs

public java.util.List getCatalogs()

Deprecated.

getCategories

public java.util.List getCategories()

isInCatalog

public boolean isInCatalog(Category inCategory)

isInCategory

public boolean isInCategory(Category inCat)

isInCategory

public boolean isInCategory(java.lang.String inCategoryId)

getDefaultColor

public Option getDefaultColor()

getDefaultSize

public Option getDefaultSize()

getSizes

public java.util.List getSizes()

getSizesSorted

public java.util.List getSizesSorted()

getColors

public java.util.List getColors()

colorsInSize

public java.util.List colorsInSize(Option inSize)

List all the colors available in this size

Parameters:

inSize -

Returns:

getInventoryItems

public java.util.List getInventoryItems()

setInventoryItems

public void setInventoryItems(java.util.List inItems)

hasSizes

public boolean hasSizes()

hasColors

public boolean hasColors()

hasSize

public boolean hasSize()

hasColor

public boolean hasColor()

getDefaultCatalog

public Category getDefaultCatalog()

Deprecated. Use getDefaultCategory instead.

getDefaultCategory

public Category getDefaultCategory()

getRelatedCatalogs

public java.util.Collection getRelatedCatalogs()

setDefaultCatalog

public void setDefaultCatalog(Category inDefaultCatalog)

Deprecated. use setDefaultCategory instead.

setDefaultCategory

public void setDefaultCategory(Category inDefaultCategory)

getProperties

public java.util.Map getProperties()

getProperty

public java.lang.String getProperty(java.lang.String inKey)

setProperties

public void setProperties(java.util.Map inAttributes)

putAttribute

public void putAttribute(java.lang.String inKey,
                         java.lang.String inValue)

setProperty

public void setProperty(java.lang.String inKey,
                        java.lang.String inValue)

clearUserCatalogs

public void clearUserCatalogs()

clearItems

public void clearItems()

getDepartment

public java.lang.String getDepartment()

setDepartment

public void setDepartment(java.lang.String fieldDepartment)

isInStock

public boolean isInStock()

isPartlyOutOfStock

public boolean isPartlyOutOfStock()

isOnSale

public boolean isOnSale()

addInventoryItem

public void addInventoryItem(InventoryItem inItem)

getInventoryItem

public InventoryItem getInventoryItem(int inI)

Parameters:

inI -

Returns:

getInventoryItemBySku

public InventoryItem getInventoryItemBySku(java.lang.String inSku)

getInventoryItemByOptions

public InventoryItem getInventoryItemByOptions(java.util.Collection inOptions)

getCloseInventoryItemByOptions

public InventoryItem getCloseInventoryItemByOptions(java.util.Set inOptions)

hasProductLevelPricing

public boolean hasProductLevelPricing()

getPriceSupport

public PriceSupport getPriceSupport()

setPriceSupport

public void setPriceSupport(PriceSupport priceSupport)

getRetailUnitPrice

public org.openedit.money.Money getRetailUnitPrice()

getYourPrice

public org.openedit.money.Money getYourPrice()

getRetailPrice

public org.openedit.money.Money getRetailPrice()

addTierPrice

public void addTierPrice(int inQuantity,
                         Price inPrice)

Parameters:

inQuantity -

money -

hasKeywords

public boolean hasKeywords()

getKeywords

public java.util.List getKeywords()

isAvailable

public boolean isAvailable()

setAvailable

public void setAvailable(boolean inAvailable)

getInventoryItemCount

public int getInventoryItemCount()

Returns:

clearCatalogs

public void clearCatalogs()

getOptions

public java.util.List getOptions()

getAllOptions

public java.util.List getAllOptions()

setOptions

public void setOptions(java.util.List inOptions)

addOption

public void addOption(Option inOption)

removeOption

public void removeOption(java.lang.String id)

clearOptions

public void clearOptions()

getOption

public Option getOption(java.lang.String inOptionId)

getHandlingChargeLevel

public java.lang.String getHandlingChargeLevel()

setHandlingChargeLevel

public void setHandlingChargeLevel(java.lang.String inHandlingChargeLevel)

isCustomPrice

public boolean isCustomPrice()

setCustomPrice

public void setCustomPrice(boolean inCustomPrice)

isTaxExempt

public boolean isTaxExempt()

setTaxExempt

public void setTaxExempt(boolean inTaxExempt)

hasProperty

public boolean hasProperty(java.lang.String inKey)

getShippingMethodId

public java.lang.String getShippingMethodId()

setShippingMethodId

public void setShippingMethodId(java.lang.String inShippingMethodId)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String inDescription)

addKeyword

public void addKeyword(java.lang.String inString)

removeKeyword

public void removeKeyword(java.lang.String inKey)

getDeliveryType

public java.lang.String getDeliveryType()

setDeliveryType

public void setDeliveryType(java.lang.String inDeliveryType)

getDate

public java.util.Date getDate(java.lang.String inField,
                              java.lang.String inDateFormat)

isRelated

public boolean isRelated(RelatedProduct inId)

setKeywords

public void setKeywords(java.util.List inKeywords)

clearKeywords

public void clearKeywords()

incrementProperty

public void incrementProperty(java.lang.String property,
                              int delta)
                       throws java.lang.Exception

Throws:

java.lang.Exception

hasRelatedProducts

public boolean hasRelatedProducts()

copy

public Product copy(java.lang.String newId)

copy

public Product copy()

setCategories

public void setCategories(java.util.List inCatalogs)

setOriginalImagePath

public void setOriginalImagePath(java.lang.String inPath)

getSourcePath

public java.lang.String getSourcePath()

setSourcePath

public void setSourcePath(java.lang.String inSourcePath)

getSourcePage

public Page getSourcePage()

setSourcePage

public void setSourcePage(Page inSourcePage)

getSaveAsName

public java.lang.String getSaveAsName()

addRelatedProduct

public void addRelatedProduct(RelatedProduct inRelationship)

getRelatedProducts

public java.util.List getRelatedProducts()

removeRelatedProduct

public void removeRelatedProduct(java.lang.String productid)

getRelatedProducts

public java.util.List getRelatedProducts(java.lang.String inType)

clearRelatedProducts

public void clearRelatedProducts()

setRelatedProducts

public void setRelatedProducts(java.util.List inRelatedProducts)

isRelated

public boolean isRelated(java.lang.String inString)

addRelatedFile

public void addRelatedFile(RelatedFile file)

hasRelatedFiles

public boolean hasRelatedFiles()

clearRelatedFiles

public void clearRelatedFiles()

getPrimaryRelatedFile

public RelatedFile getPrimaryRelatedFile()

getPrimaryImagePath

public java.lang.String getPrimaryImagePath()