|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProductProcessor
Interface for business logic methods affecting products and other related objects.
Instances implementing ProductProcessor
are usually created in
the Struts layer in response to a request from a user for product
information. The ProductProcessor
object uses data access
objects to look up the information, and return it to the Struts layer.
When the application needs to create an instance that implements
ProductProcessor
,
BusinessObjectFactory
finds the name of the Java class to instantiate from the
"productProcessorImplementer" setting in the
appComponents.properties
file.
The default "productProcessorImplementer" is
BasicProductProcessor
.
Method Summary | |
---|---|
void |
addProduct(java.util.Map parameters)
|
java.util.Collection |
buildMatrix(Product product)
|
void |
deleteProduct(java.util.Map parameters)
|
void |
editDeleteProducts(java.util.Map parameters)
|
void |
editProduct(java.util.Map parameters)
|
java.util.HashMap |
generateSettingsMap(java.util.Collection settings)
|
java.util.Collection |
getAllAttributesAndOptions(int productID)
|
Category |
getCategoryFromCode(Category category)
Retrieves category information from the database. |
Category |
getCategoryFromCode(Category category,
boolean loadProducts)
Retrieves category information from the database. |
Product |
getProductFromCode(Product product)
Retrieves product information from the database. |
ProductList |
getProductList(ProductList productList)
Retrieves information for a list of products from the database. |
java.util.Collection |
loadAllProductNamesCodesIDs()
|
java.util.Collection |
loadAllProducts()
|
java.util.Collection |
loadAttributeSKUCollection()
Retrieves all SKUs associated with attributes but not products, as a Collection of SKUs. |
java.util.Map |
loadAttributeSKUs()
Retrieves all SKUs associated with attributes but not products. |
java.util.Collection |
loadBuiltInCategories()
Retrieves a Collection containing built-in categories for
the store. |
java.util.Collection |
loadCategoryTree()
Retrieves a Collection representing the store's category
tree. |
Product |
loadProductFromID(java.util.Map parameters)
|
java.util.Map |
loadProductsAndCount(java.util.Map parameters)
|
java.util.Collection |
loadSettings(java.util.Map properties)
|
java.util.Collection |
processSettings(java.util.Map properties)
|
java.util.Map |
sortProductsByName(java.util.Map parameters)
|
Methods inherited from interface com.softslate.commerce.businessobjects.core.BusinessObject |
---|
initialize |
Method Detail |
---|
Product getProductFromCode(Product product) throws java.lang.Exception
ProductDAO.loadProduct()
to
populate the incoming Product
using its code
.
product
- A Product
object whose code
property has been populated.
Product
object with all its properties populated
from the database. If the product does not exist in the database,
null
.
java.lang.Exception
java.util.Map loadAttributeSKUs() throws java.lang.Exception
Map
of all the SKU
s in the
system associated with attributes but not products.
java.lang.Exception
java.util.Collection loadAttributeSKUCollection() throws java.lang.Exception
Collection
of all the SKU
s in
the system associated with attributes but not products.
java.lang.Exception
Category getCategoryFromCode(Category category) throws java.lang.Exception
category
- A Category
object whose code
property has been populated.
Category
object with all its properties
populated from the database. If the category does not exist in
the database, null
.
java.lang.Exception
Category getCategoryFromCode(Category category, boolean loadProducts) throws java.lang.Exception
CategoryDAO.loadCategory()
to
populate the incoming Category
using its code
.
If the loadProducts parameter is set to true, in addition to all of the
category's regular properties, its productListCollection
is populated with just those Product
s falling on the
current page being displayed. The paging parameters for the number of
items to display and which page to display come from the incoming
Category
's itemsPerPage
and
firstRow
properties, respectively.
The method
ProductGatewayDAO.loadProductList(ProductList)
is used to pull in the category's products.
Also in the default implementation, the Category
's
parentCollection
and parentString
properties are set by calling
CategoryDAO.loadParents()
.
These properties are used in breadcrumbing and in the display of the
category tree.
category
- A Category
object whose code
property has been populated.loadProducts
- If set to true, the category's products will be loaded into
the category's productListCollection
property.
Category
object with all its properties
populated from the database. If the category does not exist in
the database, null
.
java.lang.Exception
java.util.Collection loadCategoryTree() throws java.lang.Exception
Collection
representing the store's category
tree. Each item in the Collection
is an instance of
Category
, which
corresponds to each one of the "top level" categories defined in the
store (i.e., categories whose parentCategory
property is
null
). To render the tree, iterate through the top level
categories and recursively navigate through each of their
subcategoryCollection
s in turn.
The default implementation of this method calls
ProductGatewayDAOHibernate.loadCategoryTree()
,
which uses Hibernate.initialize(java.lang.Object)
to pull the entire tree from the database non-lazily.
Collection
representing the store's category
tree.
java.lang.Exception
java.util.Collection loadBuiltInCategories() throws java.lang.Exception
Collection
containing built-in categories for
the store. Each item in the Collection
is an instance of
Category
.
Built-in categories are typically composed of specials or other featured
products that need to displayed on arbitrary pages thoughout the store.
Built-in categories are definined by the "builtInCategories" setting in
the sscSetting
database table, a comma-separated list of
category codes.
Collection
of Category
objects
representing the store's built-in categories.
java.lang.Exception
ProductList getProductList(ProductList productList) throws java.lang.Exception
productListType
for the
ProductList
, the products could be the entire list of
products in the system, the products under a given category, or the
products matching a given search request.
productList
- A ProductList
object whose
itemsPerPage
,firstCode
,
productListType
, and optionally
categoryID
or searchString
and
stopWords
properties have been set.
ProductList
object with all its properties
populated from the database.
java.lang.Exception
java.util.Collection loadAllProducts() throws java.lang.Exception
java.lang.Exception
java.util.Collection loadAllProductNamesCodesIDs() throws java.lang.Exception
java.lang.Exception
java.util.Map loadProductsAndCount(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
void addProduct(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
Product loadProductFromID(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
void editProduct(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
void editDeleteProducts(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
void deleteProduct(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
java.util.HashMap generateSettingsMap(java.util.Collection settings) throws java.lang.Exception
java.lang.Exception
java.util.Collection getAllAttributesAndOptions(int productID) throws java.lang.Exception
java.lang.Exception
java.util.Collection loadSettings(java.util.Map properties) throws java.lang.Exception
java.lang.Exception
java.util.Collection processSettings(java.util.Map properties) throws java.lang.Exception
java.lang.Exception
java.util.Collection buildMatrix(Product product)
java.util.Map sortProductsByName(java.util.Map parameters) throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |