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 Store

java.lang.Object
  org.openedit.store.Store

public class Store
extends java.lang.Object

Author:

cburkey

Constructor Summary

Store()

Method Summary

void	addCreditCardType(CreditCardType inCreditCardType)
void	addNotifyAddress(java.lang.String inToAddress)
void	addToAddress(java.lang.String inToAddress)
boolean	areCouponsAccepted()
Crumb	buildCrumb(Category inCatalog)
Link	buildLink(Category inCatalog)
Link	buildLink(Category inCatalog, java.lang.String prefix)
void	clear()
void	clearProducts()
void	clearSystemWideFilter(java.lang.String inDataLevel)
ConvertStatus	convertCatalog(User inUser, boolean inForce)
Product	createProduct(java.lang.String inSourcePath)
boolean	displayTermsConditions()
ShippingMethod	findShippingMethod(java.lang.String inId)
boolean	getAllowDuplicateAccounts()
java.util.List	getAllShippingMethods()
Category	getCatalog(java.lang.String inCatalogId) Deprecated.
CategoryArchive	getCatalogArchive() Deprecated.
java.lang.String	getCatalogId()
CatalogConverter	getCatalogImportConverter()
Category	getCategory(java.lang.String inCatalogId)
CategoryArchive	getCategoryArchive()
Category	getCategoryByName(java.lang.String inCatname)
java.lang.String	getConfigValue(java.lang.String inKey)
CreditCardType	getCreditCardType(java.lang.String inString)
java.util.Set	getCreditCardTypes()
CustomerArchive	getCustomerArchive()
java.util.List	getDataProperties(java.lang.String inScreenName, User inUser) Deprecated. Use store.getProductDetails()
ElectronicOrderManager	getElectronicOrderManager()
java.lang.String	getEmailLayout()
PropertyDetailsArchive	getFieldArchive()
java.lang.String	getFromAddress()
java.lang.String	getHostName()
AutoImageCreator	getImageCreator()
java.util.List	getImageList() Returns a list of potential (not actual) images, valid for any catalog.
java.util.List	getImageList(java.lang.String inType)
long	getLastModified()
java.lang.String	getLinkToMedium(java.lang.String inSourcePath, java.lang.String inFileName)
java.lang.String	getLinkToMedium(java.lang.String inSourcePath, java.lang.String inFileName, java.lang.String inExtension)
java.lang.String	getLinkToThumb(java.lang.String inSourcePath, java.lang.String inFileName)
java.lang.String	getLinkToThumb(java.lang.String inSourcePath, java.lang.String inFileName, java.lang.String inExtension)
ProductArchive	getMirrorProductArchive()
ModuleManager	getModuleManager()
java.lang.String	getName()
java.util.List	getNotifyAddresses() These are used to notify people of an email
OrderArchive	getOrderArchive()
OrderGenerator	getOrderGenerator()
java.lang.String	getOrderLayout()
OrderProcessor	getOrderProcessor()
OrderSearcher	getOrderSearcher()
OrderState	getOrderState(java.lang.String inState)
Product	getProduct(java.lang.String inItem)
ProductArchive	getProductArchive()
Product	getProductBySourcePath(Page inPage)
Product	getProductBySourcePath(java.lang.String inSourcePath)
java.util.List	getProductDetails(java.lang.String inPropertiesName, User inUser) This returns a particular set of properties, which is a subset of the properties found in store/configuration/productproperties.xml
ProductExport	getProductExport()
ProductPathFinder	getProductPathFinder()
ProductSearcher	getProductSearch() Deprecated.
ProductSearcher	getProductSearcher()
ProductSecurityArchive	getProductSecurityArchive()
java.util.List	getProductsInCatalog(Category inCatalog)
ProductPathFinder	getProductSourcePathFinder()
HitTracker	getProperties(java.lang.String inName)
java.util.Map	getRelatedProductMap(java.lang.String inProductId)
java.util.List	getRelatedProductsInCategory(java.lang.String inProductId, java.lang.String inCatalogId)
java.io.File	getRootDirectory()
SearcherManager	getSearcherManager()
SearchFilterArchive	getSearchFilterArchive()
java.lang.String	getSmtpServer()
java.lang.String	getSourcePathForPage(WebPageRequest inPage)
java.lang.String	getStatusEmailLayout()
java.io.File	getStoreDirectory()
java.lang.String	getStoreHome()
org.openedit.money.Fraction	getTaxRateFor(java.lang.String inString)
java.util.List	getToAddresses()
XmlArchive	getXmlArchive()
boolean	isAllowSpecialRequest()
boolean	isAssignShippingMethod()
boolean	isAutoCapture()
boolean	isUseSearchSecurity()
java.util.Collection	listAllKnownProductIds()
java.util.List	listAllSortByFields()
void	processOrder(WebPageRequest inPageRequest, Order order)
void	putTaxRate(java.lang.String inState, org.openedit.money.Fraction inRate)
void	reindexAll()
void	reloadSearchIndex()
void	removeCreditCardType(CreditCardType inCreditCardType)
void	save()
void	saveCustomer(Customer customer)
void	saveOrder(Order inOrder) Save the order to the order archive system
void	saveProduct(Product inProduct)
void	saveProduct(Product inProduct, User inUser)
void	saveProducts(java.util.List inProducts)
HitTracker	search(java.lang.String inSearch)
HitTracker	search(java.lang.String inFinalq, java.lang.String inOrdering)
void	setAllowDuplicateAccounts(boolean inAllowDuplicateAccounts)
void	setAllowSpecialRequest(boolean inAllowSpecialRequest)
void	setAllShippingMethods(java.util.List inAllShippingMethods)
void	setAssignShippingMethod(boolean inAssignShippingMethod)
void	setAutoCapture(boolean inAutoCapture)
void	setCatalogId(java.lang.String inString)
void	setCatalogImportConverter(CatalogConverter inCatalogImportConverter)
void	setCategoryArchive(CategoryArchive inCatalogArchive)
void	setConfiguration(Configuration inConfiguration)
void	setCouponsAccepted(boolean inCouponsAccepted)
void	setCustomerArchive(CustomerArchive inCustomerArchive)
void	setDisplayTermsConditions(boolean inDisplayTermsConditions)
void	setElectronicOrderManager(ElectronicOrderManager inElectronicOrderManager)
void	setEmailLayout(java.lang.String inEmailLayout)
void	setFromAddress(java.lang.String inFromAddress)
void	setHostName(java.lang.String inHostName)
void	setImageCreator(AutoImageCreator inImageCreator)
void	setLastModified(long inLastModified)
void	setMirrorProductArchive(ProductArchive inMirrorProductArchive)
void	setModuleManager(ModuleManager inModuleManager)
void	setName(java.lang.String inName)
void	setNotifyAddresses(java.util.List inBccAddresses)
void	setOrderArchive(OrderArchive inOrderArchive)
void	setOrderGenerator(OrderGenerator inOrderGenerator)
void	setOrderLayout(java.lang.String inThanksLayout)
void	setOrderProcessor(OrderProcessor inOrderProcessor)
void	setProductArchive(ProductArchive inArchive)
void	setProductExport(ProductExport inProductExport)
void	setProductPathFinder(ProductPathFinder inProductPathFinder)
void	setProductSecurityArchive(ProductSecurityArchive inProductSecurityArchive)
void	setRootDirectory(java.io.File inRoot)
void	setSearcherManager(SearcherManager inSearcherManager)
void	setSearchFilterArchive(SearchFilterArchive inSearchFilterArchive)
void	setSmtpServer(java.lang.String inString)
void	setStatusEmailLayout(java.lang.String inStatusLayout)
void	setStoreDirectory(java.io.File inHome)
void	setToAddresses(java.util.List inList)
void	setUsesBillMeLater(boolean inUsesBillMeLater)
void	setUseSearchSecurity(boolean inUseSearchSecurity)
void	setUsesPoNumbers(boolean inUsesPoNumbers)
void	setXmlArchive(XmlArchive inXmlArchive)
java.lang.String	showMedium(java.lang.String inId)
java.lang.String	showThumb(java.lang.String inId)
boolean	usesBillMeLater()
boolean	usesPoNumbers()

Methods inherited from class java.lang.Object

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

Constructor Detail

Store

public Store()

Method Detail

getProductSecurityArchive

public ProductSecurityArchive getProductSecurityArchive()

setProductSecurityArchive

public void setProductSecurityArchive(ProductSecurityArchive inProductSecurityArchive)

getElectronicOrderManager

public ElectronicOrderManager getElectronicOrderManager()

setElectronicOrderManager

public void setElectronicOrderManager(ElectronicOrderManager inElectronicOrderManager)

getCreditCardTypes

public java.util.Set getCreditCardTypes()

getCatalog

public Category getCatalog(java.lang.String inCatalogId)
                    throws StoreException

Deprecated.

Use getCategory

Parameters:

inCatalogId -

Returns:

Throws:

StoreException

getCategory

public Category getCategory(java.lang.String inCatalogId)
                     throws StoreException

Throws:

StoreException

getCategoryByName

public Category getCategoryByName(java.lang.String inCatname)
                           throws StoreException

Throws:

StoreException

addCreditCardType

public void addCreditCardType(CreditCardType inCreditCardType)

removeCreditCardType

public void removeCreditCardType(CreditCardType inCreditCardType)

getCreditCardType

public CreditCardType getCreditCardType(java.lang.String inString)

getStoreHome

public java.lang.String getStoreHome()

getCatalogId

public java.lang.String getCatalogId()

setCatalogId

public void setCatalogId(java.lang.String inString)

clear

public void clear()
           throws java.lang.Exception

Throws:

java.lang.Exception

clearProducts

public void clearProducts()

getSmtpServer

public java.lang.String getSmtpServer()

getToAddresses

public java.util.List getToAddresses()

setSmtpServer

public void setSmtpServer(java.lang.String inString)

setToAddresses

public void setToAddresses(java.util.List inList)

addToAddress

public void addToAddress(java.lang.String inToAddress)

addNotifyAddress

public void addNotifyAddress(java.lang.String inToAddress)

getEmailLayout

public java.lang.String getEmailLayout()

setEmailLayout

public void setEmailLayout(java.lang.String inEmailLayout)

getFromAddress

public java.lang.String getFromAddress()

setFromAddress

public void setFromAddress(java.lang.String inFromAddress)

getTaxRateFor

public org.openedit.money.Fraction getTaxRateFor(java.lang.String inString)

Parameters:

inString -

Returns:

putTaxRate

public void putTaxRate(java.lang.String inState,
                       org.openedit.money.Fraction inRate)

getOrderLayout

public java.lang.String getOrderLayout()

setOrderLayout

public void setOrderLayout(java.lang.String inThanksLayout)

setStatusEmailLayout

public void setStatusEmailLayout(java.lang.String inStatusLayout)

getStatusEmailLayout

public java.lang.String getStatusEmailLayout()

getProduct

public Product getProduct(java.lang.String inItem)
                   throws StoreException

Throws:

StoreException

getProductArchive

public ProductArchive getProductArchive()

setProductArchive

public void setProductArchive(ProductArchive inArchive)

saveProduct

public void saveProduct(Product inProduct)
                 throws StoreException

Parameters:

inItem -

Throws:

StoreException

saveProduct

public void saveProduct(Product inProduct,
                        User inUser)
                 throws StoreException

Throws:

StoreException

saveProducts

public void saveProducts(java.util.List inProducts)
                  throws StoreException

Throws:

StoreException

save

public void save()
          throws StoreException

Throws:

StoreException

getRelatedProductMap

public java.util.Map getRelatedProductMap(java.lang.String inProductId)
                                   throws StoreException

Throws:

StoreException

getRelatedProductsInCategory

public java.util.List getRelatedProductsInCategory(java.lang.String inProductId,
                                                   java.lang.String inCatalogId)
                                            throws StoreException

Throws:

StoreException

reindexAll

public void reindexAll()
                throws OpenEditException

Throws:

OpenEditException

search

public HitTracker search(java.lang.String inSearch)
                  throws OpenEditException

Throws:

OpenEditException

getProductSearcher

public ProductSearcher getProductSearcher()

getProductSearch

public ProductSearcher getProductSearch()

Deprecated.

findShippingMethod

public ShippingMethod findShippingMethod(java.lang.String inId)

getAllShippingMethods

public java.util.List getAllShippingMethods()

setAllShippingMethods

public void setAllShippingMethods(java.util.List inAllShippingMethods)

getStoreDirectory

public java.io.File getStoreDirectory()

setStoreDirectory

public void setStoreDirectory(java.io.File inHome)

getCatalogImportConverter

public CatalogConverter getCatalogImportConverter()

setCatalogImportConverter

public void setCatalogImportConverter(CatalogConverter inCatalogImportConverter)

convertCatalog

public ConvertStatus convertCatalog(User inUser,
                                    boolean inForce)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getCatalogArchive

public CategoryArchive getCatalogArchive()

Deprecated.

getCategoryArchive

public CategoryArchive getCategoryArchive()

setCategoryArchive

public void setCategoryArchive(CategoryArchive inCatalogArchive)

getCustomerArchive

public CustomerArchive getCustomerArchive()

setCustomerArchive

public void setCustomerArchive(CustomerArchive inCustomerArchive)

saveOrder

public void saveOrder(Order inOrder)
               throws StoreException

Save the order to the order archive system

Parameters:

inCart -

Throws:

StoreException

getOrderArchive

public OrderArchive getOrderArchive()

setOrderArchive

public void setOrderArchive(OrderArchive inOrderArchive)

saveCustomer

public void saveCustomer(Customer customer)
                  throws StoreException

Throws:

StoreException

getRootDirectory

public java.io.File getRootDirectory()

Returns:

setRootDirectory

public void setRootDirectory(java.io.File inRoot)

getOrderGenerator

public OrderGenerator getOrderGenerator()

setOrderGenerator

public void setOrderGenerator(OrderGenerator inOrderGenerator)

isAssignShippingMethod

public boolean isAssignShippingMethod()

setAssignShippingMethod

public void setAssignShippingMethod(boolean inAssignShippingMethod)

getNotifyAddresses

public java.util.List getNotifyAddresses()

These are used to notify people of an email

Returns:

setNotifyAddresses

public void setNotifyAddresses(java.util.List inBccAddresses)

getHostName

public java.lang.String getHostName()

setHostName

public void setHostName(java.lang.String inHostName)

areCouponsAccepted

public boolean areCouponsAccepted()

setCouponsAccepted

public void setCouponsAccepted(boolean inCouponsAccepted)

usesPoNumbers

public boolean usesPoNumbers()

setUsesPoNumbers

public void setUsesPoNumbers(boolean inUsesPoNumbers)

displayTermsConditions

public boolean displayTermsConditions()

setDisplayTermsConditions

public void setDisplayTermsConditions(boolean inDisplayTermsConditions)

usesBillMeLater

public boolean usesBillMeLater()

setUsesBillMeLater

public void setUsesBillMeLater(boolean inUsesBillMeLater)

getAllowDuplicateAccounts

public boolean getAllowDuplicateAccounts()

setAllowDuplicateAccounts

public void setAllowDuplicateAccounts(boolean inAllowDuplicateAccounts)

getProductPathFinder

public ProductPathFinder getProductPathFinder()

setProductPathFinder

public void setProductPathFinder(ProductPathFinder inProductPathFinder)

getProductSourcePathFinder

public ProductPathFinder getProductSourcePathFinder()

showThumb

public java.lang.String showThumb(java.lang.String inId)

showMedium

public java.lang.String showMedium(java.lang.String inId)

search

public HitTracker search(java.lang.String inFinalq,
                         java.lang.String inOrdering)
                  throws OpenEditException

Throws:

OpenEditException

isAllowSpecialRequest

public boolean isAllowSpecialRequest()

setAllowSpecialRequest

public void setAllowSpecialRequest(boolean inAllowSpecialRequest)

getProductsInCatalog

public java.util.List getProductsInCatalog(Category inCatalog)
                                    throws OpenEditException

Throws:

OpenEditException

buildCrumb

public Crumb buildCrumb(Category inCatalog)

buildLink

public Link buildLink(Category inCatalog)

buildLink

public Link buildLink(Category inCatalog,
                      java.lang.String prefix)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String inName)

isAutoCapture

public boolean isAutoCapture()

setAutoCapture

public void setAutoCapture(boolean inAutoCapture)

getOrderState

public OrderState getOrderState(java.lang.String inState)

getProductExport

public ProductExport getProductExport()

setProductExport

public void setProductExport(ProductExport inProductExport)

getMirrorProductArchive

public ProductArchive getMirrorProductArchive()

setMirrorProductArchive

public void setMirrorProductArchive(ProductArchive inMirrorProductArchive)

getLastModified

public long getLastModified()

setLastModified

public void setLastModified(long inLastModified)

setConfiguration

public void setConfiguration(Configuration inConfiguration)

getConfigValue

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

getProperties

public HitTracker getProperties(java.lang.String inName)
                         throws OpenEditException

Throws:

OpenEditException

getDataProperties

public java.util.List getDataProperties(java.lang.String inScreenName,
                                        User inUser)
                                 throws java.lang.Exception

Deprecated. Use store.getProductDetails()

Parameters:

inType -

inUser -

Returns:

Throws:

java.lang.Exception

getProductDetails

public java.util.List getProductDetails(java.lang.String inPropertiesName,
                                        User inUser)
                                 throws java.lang.Exception

This returns a particular set of properties, which is a subset of the properties found in store/configuration/productproperties.xml

Parameters:

inSubsetProperties - Identifies the file to look in for the subset of properties to take from those found in productproperties.xml The file is store/configuration/fields/properties{inSubsetProperties}.xml

inUser -

Returns:

A List of Details

Throws:

java.lang.Exception

getXmlArchive

public XmlArchive getXmlArchive()

setXmlArchive

public void setXmlArchive(XmlArchive inXmlArchive)

listAllSortByFields

public java.util.List listAllSortByFields()

getFieldArchive

public PropertyDetailsArchive getFieldArchive()

getOrderSearcher

public OrderSearcher getOrderSearcher()

clearSystemWideFilter

public void clearSystemWideFilter(java.lang.String inDataLevel)
                           throws OpenEditException

Throws:

OpenEditException

processOrder

public void processOrder(WebPageRequest inPageRequest,
                         Order order)
                  throws StoreException

Throws:

StoreException

getOrderProcessor

public OrderProcessor getOrderProcessor()

setOrderProcessor

public void setOrderProcessor(OrderProcessor inOrderProcessor)

isUseSearchSecurity

public boolean isUseSearchSecurity()

setUseSearchSecurity

public void setUseSearchSecurity(boolean inUseSearchSecurity)

reloadSearchIndex

public void reloadSearchIndex()

getSearcherManager

public SearcherManager getSearcherManager()

setSearcherManager

public void setSearcherManager(SearcherManager inSearcherManager)

getImageList

public java.util.List getImageList()

Returns a list of potential (not actual) images, valid for any catalog.

Returns:

A List of Images

getImageList

public java.util.List getImageList(java.lang.String inType)
                            throws StoreException

Throws:

StoreException

getLinkToThumb

public java.lang.String getLinkToThumb(java.lang.String inSourcePath,
                                       java.lang.String inFileName,
                                       java.lang.String inExtension)

getLinkToThumb

public java.lang.String getLinkToThumb(java.lang.String inSourcePath,
                                       java.lang.String inFileName)

getLinkToMedium

public java.lang.String getLinkToMedium(java.lang.String inSourcePath,
                                        java.lang.String inFileName,
                                        java.lang.String inExtension)

getLinkToMedium

public java.lang.String getLinkToMedium(java.lang.String inSourcePath,
                                        java.lang.String inFileName)

getImageCreator

public AutoImageCreator getImageCreator()

setImageCreator

public void setImageCreator(AutoImageCreator inImageCreator)

listAllKnownProductIds

public java.util.Collection listAllKnownProductIds()

getSearchFilterArchive

public SearchFilterArchive getSearchFilterArchive()

setSearchFilterArchive

public void setSearchFilterArchive(SearchFilterArchive inSearchFilterArchive)

getSourcePathForPage

public java.lang.String getSourcePathForPage(WebPageRequest inPage)

getProductBySourcePath

public Product getProductBySourcePath(java.lang.String inSourcePath)

createProduct

public Product createProduct(java.lang.String inSourcePath)

getProductBySourcePath

public Product getProductBySourcePath(Page inPage)

getModuleManager

public ModuleManager getModuleManager()

setModuleManager

public void setModuleManager(ModuleManager inModuleManager)