com.beasys.commerce.ebusiness.catalog.sql
Interface CatalogSqlManager

All Known Implementing Classes:

JdbcSqlManager

public interface CatalogSqlManager

The CatalogSqlManager interface defines the API catalog services use to read and write catalog information to a SQL compliant database.
This is an advanced (internal) class and may be subject to change.

Method Summary

void	addItem(Connection connection, CatalogRequest request, CategoryKey categoryKey, ProductItemKey itemKey) Adds an item to the specified category.
void	createCategory(Connection connection, CatalogRequest request, CategoryKey parentKey, Category category) Creates a sub category within the supplied parent category.
void	createItem(Connection connection, CatalogRequest request, ProductItem product) Creates a new product item.
Category[]	getAncestors(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the ancestors of the specified category in ascending order.
CatalogSchemaManager	getCatalogSchemaManager()
Category[]	getCategories(Connection connection, CatalogRequest request, CategoryKey[] categoryKeys) Returns the categories with the given category keys.
Category	getCategory(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the category with the given category key.
int	getCategoryCount(Connection connection, CatalogRequest request) Returns the total number of categories in the product catalog.
CategoryKey[]	getCategoryKeys(Connection connection, CatalogRequest request, int beginIndex, int endIndex) Returns an array of all existing category keys within the specified ordered range.
ProductItem	getItem(Connection connection, CatalogRequest request, ProductItemKey productKey) Returns the product item with the specified key.
int	getItemCount(Connection connection, CatalogRequest request) Returns the number of product items in the product catalog.
int	getItemCount(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the number of product items associated with the specified category.
ProductItemKey[]	getItemKeys(Connection connection, CatalogRequest request, CategoryKey categoryKey, int beginIndex, int endIndex) Returns an array of all product item keys of the specified category within the specified ordered range.
ProductItemKey[]	getItemKeys(Connection connection, CatalogRequest request, int beginIndex, int endIndex) Returns an array over all existing product item keys within the specified ordered range.
ProductItem[]	getItems(Connection connection, CatalogRequest request, ProductItemKey[] productKeys) Returns the product items with the given product item keys.
JdbcCatalogFactory	getJdbcCatalogFactory()
String[]	getKeywords(Connection connection, CatalogRequest request, ProductItemKey productKey) Returns the keywords associated with a given product item.
int	getOrphanedItemCount(Connection connection, CatalogRequest request) Returns the number of orphaned items in the catalog.
ProductItemKey[]	getOrphanedItemKeys(Connection connection, CatalogRequest request, int beginIndex, int endIndex) Returns an array of all existing orphaned category keys within the specified ordered range.
Category	getParent(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the parent of the specified category.
Category	getRootCategory(Connection connection, CatalogRequest request) Returns the root category.
int	getSiblingCount(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the number of siblings associated with the specified category.
CategoryKey[]	getSiblingKeys(Connection connection, CatalogRequest request, CategoryKey categoryKey, int beginIndex, int endIndex) Returns an array of all exististing sibling keys of the specified category within the specified ordered range.
int	getSubCategoryCount(Connection connection, CatalogRequest request, CategoryKey categoryKey) Returns the number of sub categories associated with the specified category.
CategoryKey[]	getSubCategoryKeys(Connection connection, CatalogRequest request, CategoryKey categoryKey, int beginIndex, int endIndex) Returns an array of all sub category keys of the specified category within the specified ordered range.
void	initialize(String schemaName)
void	moveCategory(Connection connection, CatalogRequest request, CategoryKey categoryKey, CategoryKey newParentKey) Moves the specifed category.
void	removeCategory(Connection connection, CatalogRequest request, CategoryKey categoryKey) Removes the specifed category.
void	removeItem(Connection connection, CatalogRequest request, CategoryKey categoryKey, ProductItemKey itemKey) Removes an item from the specified category.
void	removeItem(Connection connection, CatalogRequest request, ProductItemKey productKey) Removes a product item.
void	setKeywords(Connection connection, CatalogRequest request, ProductItemKey productKey, String[] keywords) Sets the keywords for a given product item.
void	updateCategory(Connection connection, CatalogRequest request, Category category) Updates the specifed category.
void	updateItem(Connection connection, CatalogRequest request, ProductItem product) Updates a product item.

Method Detail

addItem

public void addItem(Connection connection,
                    CatalogRequest request,
                    CategoryKey categoryKey,
                    ProductItemKey itemKey)
             throws CatalogFinderException,
                    CatalogException,
                    SQLException

Adds an item to the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of target category.

itemKey - The key of the target item.

Throws:

CatalogFinderException - if the target category or item could not be found.

CatalogException - on general error.

SQLException - on database access error.

createCategory

public void createCategory(Connection connection,
                           CatalogRequest request,
                           CategoryKey parentKey,
                           Category category)
                    throws CatalogCreateException,
                           CatalogException,
                           SQLException

Creates a sub category within the supplied parent category.

Parameters:

connection - The database connection object.

request - The catalog request object.

parentKey - The key of the target parent category.

category - The category to persist.

Throws:

CatalogCreateException - on category creation error.

CatalogException - on general error.

SQLException - on database access error.

createItem

public void createItem(Connection connection,
                       CatalogRequest request,
                       ProductItem product)
                throws CatalogCreateException,
                       CatalogException,
                       SQLException

Creates a new product item.

Parameters:

connection - The database connection object.

request - The catalog request object.

product - The product item to persist.

Throws:

CatalogCreateException - if the product item could not be created.

CatalogException - on general error.

SQLException - on database access error.

getAncestors

public Category[] getAncestors(Connection connection,
                               CatalogRequest request,
                               CategoryKey categoryKey)
                        throws CatalogException,
                               SQLException

Returns the ancestors of the specified category in ascending order.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

An array of ancestor categories in ascending order.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getCatalogSchemaManager

public CatalogSchemaManager getCatalogSchemaManager()

getCategories

public Category[] getCategories(Connection connection,
                                CatalogRequest request,
                                CategoryKey[] categoryKeys)
                         throws CatalogFinderException,
                                CatalogException,
                                SQLException

Returns the categories with the given category keys.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The categories with the given category keys.

Throws:

CatalogFinderException - if a category with a given key does not exist.

CatalogException - on general error.

SQLException - on database access error.

getCategory

public Category getCategory(Connection connection,
                            CatalogRequest request,
                            CategoryKey categoryKey)
                     throws CatalogFinderException,
                            CatalogException,
                            SQLException

Returns the category with the given category key.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

The category with the given category key.

Throws:

CatalogFinderException - if a category with the given key does not exist.

CatalogException - on general error.

SQLException - on database access error.

getCategoryCount

public int getCategoryCount(Connection connection,
                            CatalogRequest request)
                     throws CatalogException,
                            SQLException

Returns the total number of categories in the product catalog.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The total number of categories in the product catalog.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getCategoryKeys

public CategoryKey[] getCategoryKeys(Connection connection,
                                     CatalogRequest request,
                                     int beginIndex,
                                     int endIndex)
                              throws CatalogException,
                                     SQLException

Returns an array of all existing category keys within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

beginIndex - The lower bound index for returned category keys.

endIndex - The upper bound index for returned category keys.

Returns:

An array of the category keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getItem

public ProductItem getItem(Connection connection,
                           CatalogRequest request,
                           ProductItemKey productKey)
                    throws CatalogFinderException,
                           CatalogException,
                           SQLException

Returns the product item with the specified key.

Parameters:

connection - The database connection object.

request - The catalog request object.

productKey - The key of the target product.

Throws:

CatalogFinderException - if the product item could not be found.

CatalogException - on general error.

SQLException - on database access error.

getItemCount

public int getItemCount(Connection connection,
                        CatalogRequest request)
                 throws CatalogException,
                        SQLException

Returns the number of product items in the product catalog.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The number of product items in the product catalog.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getItemCount

public int getItemCount(Connection connection,
                        CatalogRequest request,
                        CategoryKey categoryKey)
                 throws CatalogFinderException,
                        CatalogException,
                        SQLException

Returns the number of product items associated with the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

The number of product items associated with the specified category.

Throws:

CatalogFinderException - if the specified category could not be found.

CatalogException - on general error.

SQLException - on database access error.

getItemKeys

public ProductItemKey[] getItemKeys(Connection connection,
                                    CatalogRequest request,
                                    CategoryKey categoryKey,
                                    int beginIndex,
                                    int endIndex)
                             throws CatalogException,
                                    SQLException

Returns an array of all product item keys of the specified category within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

beginIndex - The lower bound index for returned product item keys.

endIndex - The upper bound index for returned product item keys.

Returns:

An array of all the product item keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getItemKeys

public ProductItemKey[] getItemKeys(Connection connection,
                                    CatalogRequest request,
                                    int beginIndex,
                                    int endIndex)
                             throws CatalogException,
                                    SQLException

Returns an array over all existing product item keys within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

beginIndex - The lower bound index for returned product item keys.

endIndex - The upper bound index for returned product item keys.

Returns:

An array of the product item keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getItems

public ProductItem[] getItems(Connection connection,
                              CatalogRequest request,
                              ProductItemKey[] productKeys)
                       throws CatalogFinderException,
                              CatalogException,
                              SQLException

Returns the product items with the given product item keys.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The product items with the given product item keys.

Throws:

CatalogFinderException - if a product item with a given key does not exist.

CatalogException - on general error.

SQLException - on database access error.

getJdbcCatalogFactory

public JdbcCatalogFactory getJdbcCatalogFactory()

getKeywords

public String[] getKeywords(Connection connection,
                            CatalogRequest request,
                            ProductItemKey productKey)
                     throws CatalogFinderException,
                            CatalogException,
                            SQLException

Returns the keywords associated with a given product item.

Parameters:

connection - The database connection object.

request - The catalog request object.

productKey - The key of the target product.

Returns:

The keywords associated with the given product item. If there are no keywords associated with the item, a zero length <code>String</code> array is returned.

Throws:

CatalogFinderException - if the product item could not be found.

CatalogException - on general error.

SQLException - on database access error.

getOrphanedItemCount

public int getOrphanedItemCount(Connection connection,
                                CatalogRequest request)
                         throws CatalogException,
                                SQLException

Returns the number of orphaned items in the catalog.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The number of orphaned items in the catalog.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getOrphanedItemKeys

public ProductItemKey[] getOrphanedItemKeys(Connection connection,
                                            CatalogRequest request,
                                            int beginIndex,
                                            int endIndex)
                                     throws CatalogException,
                                            SQLException

Returns an array of all existing orphaned category keys within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

beginIndex - The lower bound index for returned category keys.

endIndex - The upper bound index for returned category keys.

Returns:

An array of the orphaned category keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getParent

public Category getParent(Connection connection,
                          CatalogRequest request,
                          CategoryKey categoryKey)
                   throws CatalogFinderException,
                          CatalogException,
                          SQLException

Returns the parent of the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

The parent of the specified category.

Throws:

CatalogFinderException - if the parent could not be found. This could happen if the specified category does not exist or is the root category.

CatalogException - on general error.

SQLException - on database access error.

getRootCategory

public Category getRootCategory(Connection connection,
                                CatalogRequest request)
                         throws CatalogCreateException,
                                CatalogException,
                                SQLException

Returns the root category. If the root category does not exist, it will be created.

Parameters:

connection - The database connection object.

request - The catalog request object.

Returns:

The root category.

Throws:

CatalogCreateException - if the root category could not be created.

CatalogException - on general error.

SQLException - on database access error.

getSiblingCount

public int getSiblingCount(Connection connection,
                           CatalogRequest request,
                           CategoryKey categoryKey)
                    throws CatalogFinderException,
                           CatalogException,
                           SQLException

Returns the number of siblings associated with the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

The number of siblings associated with the specified category.

Throws:

CatalogFinderException - if the specified category could not be found.

CatalogException - on general error.

SQLException - on database access error.

getSiblingKeys

public CategoryKey[] getSiblingKeys(Connection connection,
                                    CatalogRequest request,
                                    CategoryKey categoryKey,
                                    int beginIndex,
                                    int endIndex)
                             throws CatalogException,
                                    SQLException

Returns an array of all exististing sibling keys of the specified category within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

beginIndex - The lower bound index for returned sibling keys.

endIndex - The upper bound index for returned sibling keys.

Returns:

An array of the sibling keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

getSubCategoryCount

public int getSubCategoryCount(Connection connection,
                               CatalogRequest request,
                               CategoryKey categoryKey)
                        throws CatalogFinderException,
                               CatalogException,
                               SQLException

Returns the number of sub categories associated with the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Returns:

The number of sub categories associated with the specified category.

Throws:

CatalogFinderException - if the specified category could not be found.

CatalogException - on general error.

SQLException - on database access error.

getSubCategoryKeys

public CategoryKey[] getSubCategoryKeys(Connection connection,
                                        CatalogRequest request,
                                        CategoryKey categoryKey,
                                        int beginIndex,
                                        int endIndex)
                                 throws CatalogException,
                                        SQLException

Returns an array of all sub category keys of the specified category within the specified ordered range.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

beginIndex - The lower bound index for returned sub category keys.

endIndex - The upper bound index for returned sub category keys.

Returns:

An array of all the sub category keys.

Throws:

CatalogException - on general error.

SQLException - on database access error.

initialize

public void initialize(String schemaName)

moveCategory

public void moveCategory(Connection connection,
                         CatalogRequest request,
                         CategoryKey categoryKey,
                         CategoryKey newParentKey)
                  throws CatalogFinderException,
                         CatalogException,
                         SQLException

Moves the specifed category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Throws:

CatalogFinderException - if the specified target or parent category could not be found.

CatalogException - on general error.

SQLException - on database access error.

removeCategory

public void removeCategory(Connection connection,
                           CatalogRequest request,
                           CategoryKey categoryKey)
                    throws CatalogRemoveException,
                           CatalogFinderException,
                           CatalogException,
                           SQLException

Removes the specifed category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of the target category.

Throws:

CatalogRemoveException - if the specified category could not be removed.

CatalogFinderException - if the specified category could not be found.

CatalogException - on general error.

SQLException - on database access error.

removeItem

public void removeItem(Connection connection,
                       CatalogRequest request,
                       CategoryKey categoryKey,
                       ProductItemKey itemKey)
                throws CatalogFinderException,
                       CatalogException,
                       SQLException

Removes an item from the specified category.

Parameters:

connection - The database connection object.

request - The catalog request object.

categoryKey - The key of target category.

itemKey - The key of the target item.

Throws:

CatalogFinderException - if the target category could not be found.

CatalogException - on general error.

SQLException - on database access error.

removeItem

public void removeItem(Connection connection,
                       CatalogRequest request,
                       ProductItemKey productKey)
                throws CatalogRemoveException,
                       CatalogFinderException,
                       CatalogException,
                       SQLException

Removes a product item.

Parameters:

connection - The database connection object.

request - The catalog request object.

Throws:

CatalogRemoveException - if the product item could not be removed.

CatalogFinderException - if the product item could not be found.

CatalogException - on general error.

SQLException - on database access error.

setKeywords

public void setKeywords(Connection connection,
                        CatalogRequest request,
                        ProductItemKey productKey,
                        String[] keywords)
                 throws CatalogFinderException,
                        CatalogException,
                        SQLException

Sets the keywords for a given product item.

Parameters:

connection - The database connection object.

request - The catalog request object.

productKey - The key of the target product.

keywords - The keywords to associate with the given product item.

Throws:

CatalogFinderException - if the product item could not be found.

CatalogException - on general error.

SQLException - on database access error.

updateCategory

public void updateCategory(Connection connection,
                           CatalogRequest request,
                           Category category)
                    throws CatalogFinderException,
                           CatalogException,
                           SQLException

Updates the specifed category.

Parameters:

connection - The database connection object.

request - The catalog request object.

category - The category to update.

Throws:

CatalogFinderException - if the specified category could not be found.

CatalogException - on general error.

SQLException - on database access error.

updateItem

public void updateItem(Connection connection,
                       CatalogRequest request,
                       ProductItem product)
                throws CatalogFinderException,
                       CatalogException,
                       SQLException

Updates a product item.

Parameters:

connection - The database connection object.

request - The catalog request object.

product - The product item to update.

Throws:

CatalogFinderException - if the product item could not be found.

CatalogException - on general error.

SQLException - on database access error.