Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.beasys.commerce.ebusiness.catalog.service.category
Class CMCategoryManagerBean

java.lang.Object
  extended by com.beasys.commerce.foundation.SessionImpl
      extended by com.beasys.commerce.ebusiness.catalog.service.CatalogServiceImpl
          extended by com.beasys.commerce.ebusiness.catalog.service.category.CMCategoryManagerBean
All Implemented Interfaces
CategoryManagerBusiness
public class CMCategoryManagerBean
extends CatalogServiceImpl
implements CategoryManagerBusiness

Field Summary
 
Fields inherited from class com.beasys.commerce.ebusiness.catalog.service.CatalogServiceImpl
CATALOG_MANAGER_HOME, CATALOG_QUERY_DELEGATE, CATEGORY_DELEGATE, CUSTOM_DATA_DELEGATE, PRODUCT_ITEM_DELEGATE
 
Fields inherited from class com.beasys.commerce.foundation.SessionImpl
_ctx, _environmentNamingContext, _environmentPropertyCache, _isDirty
 
Constructor Summary
CMCategoryManagerBean()
           
 
Method Summary
 void addItem(CatalogRequest request, CategoryKey categoryKey, ProductItemKey itemKey)
          Adds an item to the specified category.
 void createCategory(CatalogRequest request, CategoryKey parentKey, Category category)
          Creates a sub category within the supplied parent category.
 Category[] getAncestors(CatalogRequest request, CategoryKey categoryKey)
          Returns the ancestors of the specified category in ascending order.
 Category[] getCategories(CatalogRequest request, CategoryKey[] categoryKeys)
          Returns the categories with the given category keys.
 ViewIterator getCategories(CatalogRequest request, int viewSize)
          Returns a ViewIterator over all existing categories.
 Category getCategory(CatalogRequest request, CategoryKey categoryKey)
          Returns the category with the given category key.
 int getCategoryCount(CatalogRequest request)
          Returns the total number of categories in the product catalog.
 CategoryKey[] getCategoryKeys(CatalogRequest request, int beginIndex, int endIndex)
          Returns an array of all existing category keys within the specified ordered range.
protected  CategoryManagerBusiness getCategoryManagerDelegate()
           
 CategoryKey[] getItemCategories(CatalogRequest request, ProductItemKey productKey)
          Gets all the categories that an item is a part of.
 CategoryKey[][] getItemCategories(CatalogRequest request, ProductItemKey[] productKeys)
          Returns an array of arrays of all the categories that items are part of.
 int getItemCount(CatalogRequest request, CategoryKey categoryKey)
          Returns the number of product items associated with the specified category.
 ProductItemKey[] getItemKeys(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.
 ViewIterator getItems(CatalogRequest request, CategoryKey categoryKey, int viewSize)
          Returns a ViewIterator over all product items of the specified category.
 int getOrphanedItemCount(CatalogRequest request)
          Returns the number of orphaned items in the catalog.
 ProductItemKey[] getOrphanedItemKeys(CatalogRequest request, int beginIndex, int endIndex)
          Returns an array of all existing orphaned item keys within the specified ordered range.
 ViewIterator getOrphanedItems(CatalogRequest request, int viewSize)
          Returns a ViewIterator over all existing orphaned categories.
 Category getParent(CatalogRequest request, CategoryKey categoryKey)
          Returns the parent of the specified category.
 Category getRootCategory(CatalogRequest request)
          Returns the root category.
 int getSiblingCount(CatalogRequest request, CategoryKey categoryKey)
          Returns the number of siblings associated with the specified category.
 CategoryKey[] getSiblingKeys(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.
 ViewIterator getSiblings(CatalogRequest request, CategoryKey categoryKey, int viewSize)
          Returns a ViewIterator over all siblings of the specified category.
 ViewIterator getSubCategories(CatalogRequest request, CategoryKey categoryKey, int viewSize)
          Returns a ViewIterator over all sub categories of the specified category.
 int getSubCategoryCount(CatalogRequest request, CategoryKey categoryKey)
          Returns the number of sub categories associated with the specified category.
 CategoryKey[] getSubCategoryKeys(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 moveCategory(CatalogRequest request, CategoryKey categoryKey, CategoryKey newParentKey)
          Moves the specifed category.
 void removeCategory(CatalogRequest request, CategoryKey categoryKey)
          Removes the specifed category.
 void removeItem(CatalogRequest request, CategoryKey categoryKey, ProductItemKey itemKey)
          Removes an item from the specified category.
 void updateCategory(CatalogRequest request, Category category)
          Updates the specifed category.
 
Methods inherited from class com.beasys.commerce.ebusiness.catalog.service.CatalogServiceImpl
ejbActivate, ejbCreate, ejbPassivate, ejbPostCreate, ejbRemove, getCatalogManager, getCatalogManagerJndiName, getConfigBean, setDelegateName, setSessionContext, validateAuthorization
 
Methods inherited from class com.beasys.commerce.foundation.SessionImpl
clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, doRelationalBinding, doRelationalBinding, doRelationalBindingOnElement, doRelationalBindingOnElement, doRelationalBindingOnSingleton, doRelationalBindingOnSingleton, doRelationalBindingWithMapKey, doRelationalBindingWithMapKey, enumerateRelationalBinding, enumerateRelationalBinding, getEnvironmentNamingContext, getEnvironmentProperty, getEnvironmentProperty, getEnvironmentPropertyCache, getPersistenceHelperPlugin, getSessionContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMCategoryManagerBean

public CMCategoryManagerBean()
Method Detail

getCategoryManagerDelegate

protected CategoryManagerBusiness getCategoryManagerDelegate()
                                                      throws CatalogException
Throws
CatalogException

getRootCategory

public Category getRootCategory(CatalogRequest request)
                         throws RemoteException,
                                CatalogCreateException,
                                CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the root category. If the root category does not exist, it will be created.

Specified by:
getRootCategory in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
Returns
The root category.
Throws
CatalogCreateException - if the root category could not be created.
CatalogException - on general error.
RemoteException

getCategoryCount

public int getCategoryCount(CatalogRequest request)
                     throws RemoteException,
                            CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the total number of categories in the product catalog.

Specified by:
getCategoryCount in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
Returns
The total number of categories in the product catalog.
Throws
CatalogException - on general error.
RemoteException

getItemCount

public int getItemCount(CatalogRequest request,
                        CategoryKey categoryKey)
                 throws RemoteException,
                        CatalogFinderException,
                        CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the number of product items associated with the specified category.

Specified by:
getItemCount in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getSubCategoryCount

public int getSubCategoryCount(CatalogRequest request,
                               CategoryKey categoryKey)
                        throws RemoteException,
                               CatalogFinderException,
                               CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the number of sub categories associated with the specified category.

Specified by:
getSubCategoryCount in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getSiblingCount

public int getSiblingCount(CatalogRequest request,
                           CategoryKey categoryKey)
                    throws RemoteException,
                           CatalogFinderException,
                           CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the number of siblings associated with the specified category.

Specified by:
getSiblingCount in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getOrphanedItemCount

public int getOrphanedItemCount(CatalogRequest request)
                         throws RemoteException,
                                CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the number of orphaned items in the catalog.

Specified by:
getOrphanedItemCount in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
Returns
The number of orphaned items in the catalog.
Throws
CatalogException - on general error.
RemoteException

getCategory

public Category getCategory(CatalogRequest request,
                            CategoryKey categoryKey)
                     throws RemoteException,
                            CatalogFinderException,
                            CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the category with the given category key.

Specified by:
getCategory in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getCategories

public Category[] getCategories(CatalogRequest request,
                                CategoryKey[] categoryKeys)
                         throws RemoteException,
                                CatalogFinderException,
                                CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the categories with the given category keys.

Specified by:
getCategories in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
categoryKeys - The keys of the target categories.
Returns
The categories with the given category keys.
Throws
CatalogFinderException - if a category with a given key does not exist.
CatalogException - on general error.
RemoteException

getCategoryKeys

public CategoryKey[] getCategoryKeys(CatalogRequest request,
                                     int beginIndex,
                                     int endIndex)
                              throws RemoteException,
                                     CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of all existing category keys within the specified ordered range.

Specified by:
getCategoryKeys in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getCategories

public ViewIterator getCategories(CatalogRequest request,
                                  int viewSize)
                           throws RemoteException,
                                  CatalogException
Description copied from interface: CategoryManagerBusiness
Returns a ViewIterator over all existing categories.

Specified by:
getCategories in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
viewSize - The view size of the returned ViewIterator.
Returns
A ViewIterator over the categories.
Throws
CatalogException - on general error.
RemoteException

getSiblingKeys

public CategoryKey[] getSiblingKeys(CatalogRequest request,
                                    CategoryKey categoryKey,
                                    int beginIndex,
                                    int endIndex)
                             throws RemoteException,
                                    CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of all exististing sibling keys of the specified category within the specified ordered range.

Specified by:
getSiblingKeys in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getSiblings

public ViewIterator getSiblings(CatalogRequest request,
                                CategoryKey categoryKey,
                                int viewSize)
                         throws RemoteException,
                                CatalogException
Description copied from interface: CategoryManagerBusiness
Returns a ViewIterator over all siblings of the specified category.

Specified by:
getSiblings in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
categoryKey - The key of the target category.
viewSize - The view size of the returned ViewIterator.
Returns
A ViewIterator over all siblings.
Throws
CatalogException - on general error.
RemoteException

getSubCategoryKeys

public CategoryKey[] getSubCategoryKeys(CatalogRequest request,
                                        CategoryKey categoryKey,
                                        int beginIndex,
                                        int endIndex)
                                 throws RemoteException,
                                        CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of all sub category keys of the specified category within the specified ordered range.

Specified by:
getSubCategoryKeys in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getSubCategories

public ViewIterator getSubCategories(CatalogRequest request,
                                     CategoryKey categoryKey,
                                     int viewSize)
                              throws RemoteException,
                                     CatalogException
Description copied from interface: CategoryManagerBusiness
Returns a ViewIterator over all sub categories of the specified category.

Specified by:
getSubCategories in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
categoryKey - The key of the target category.
viewSize - The view size of the returned ViewIterator.
Returns
A ViewIterator over all the sub categories.
Throws
CatalogException - on general error.
RemoteException

getAncestors

public Category[] getAncestors(CatalogRequest request,
                               CategoryKey categoryKey)
                        throws RemoteException,
                               CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the ancestors of the specified category in ascending order.

Specified by:
getAncestors in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getParent

public Category getParent(CatalogRequest request,
                          CategoryKey categoryKey)
                   throws RemoteException,
                          CatalogFinderException,
                          CatalogException
Description copied from interface: CategoryManagerBusiness
Returns the parent of the specified category.

Specified by:
getParent in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getItemKeys

public ProductItemKey[] getItemKeys(CatalogRequest request,
                                    CategoryKey categoryKey,
                                    int beginIndex,
                                    int endIndex)
                             throws RemoteException,
                                    CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of all product item keys of the specified category within the specified ordered range.

Specified by:
getItemKeys in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getItems

public ViewIterator getItems(CatalogRequest request,
                             CategoryKey categoryKey,
                             int viewSize)
                      throws RemoteException,
                             CatalogException
Description copied from interface: CategoryManagerBusiness
Returns a ViewIterator over all product items of the specified category.

Specified by:
getItems in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
categoryKey - The key of the target category.
viewSize - The view size of the returned ViewIterator.
Returns
A ViewIterator over all product items.
Throws
CatalogException - on general error.
RemoteException

getOrphanedItemKeys

public ProductItemKey[] getOrphanedItemKeys(CatalogRequest request,
                                            int beginIndex,
                                            int endIndex)
                                     throws RemoteException,
                                            CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of all existing orphaned item keys within the specified ordered range.

Specified by:
getOrphanedItemKeys in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getOrphanedItems

public ViewIterator getOrphanedItems(CatalogRequest request,
                                     int viewSize)
                              throws RemoteException,
                                     CatalogException
Description copied from interface: CategoryManagerBusiness
Returns a ViewIterator over all existing orphaned categories.

Specified by:
getOrphanedItems in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
viewSize - The view size of the returned ViewIterator.
Returns
A ViewIterator over all existing orphaned categories.
Throws
CatalogException - on general error.
RemoteException

createCategory

public void createCategory(CatalogRequest request,
                           CategoryKey parentKey,
                           Category category)
                    throws RemoteException,
                           CatalogCreateException,
                           CatalogException
Description copied from interface: CategoryManagerBusiness
Creates a sub category within the supplied parent category.

Specified by:
createCategory in interface CategoryManagerBusiness
Parameters
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.
RemoteException

removeCategory

public void removeCategory(CatalogRequest request,
                           CategoryKey categoryKey)
                    throws RemoteException,
                           CatalogRemoveException,
                           CatalogFinderException,
                           CatalogException
Description copied from interface: CategoryManagerBusiness
Removes the specifed category.

Specified by:
removeCategory in interface CategoryManagerBusiness
Parameters
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.
RemoteException

updateCategory

public void updateCategory(CatalogRequest request,
                           Category category)
                    throws RemoteException,
                           CatalogFinderException,
                           CatalogException
Description copied from interface: CategoryManagerBusiness
Updates the specifed category.

Specified by:
updateCategory in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
category - The category to update.
Throws
CatalogFinderException - if the specified category could not be found.
CatalogException - on general error.
RemoteException

moveCategory

public void moveCategory(CatalogRequest request,
                         CategoryKey categoryKey,
                         CategoryKey newParentKey)
                  throws RemoteException,
                         CatalogFinderException,
                         CatalogException
Description copied from interface: CategoryManagerBusiness
Moves the specifed category.

Specified by:
moveCategory in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
categoryKey - The key of the target category.
newParentKey - The key of the new parent category.
Throws
CatalogFinderException - if the specified target or parent category could not be found.
CatalogException - on general error.
RemoteException

addItem

public void addItem(CatalogRequest request,
                    CategoryKey categoryKey,
                    ProductItemKey itemKey)
             throws RemoteException,
                    CatalogFinderException,
                    CatalogException
Description copied from interface: CategoryManagerBusiness
Adds an item to the specified category.

Specified by:
addItem in interface CategoryManagerBusiness
Parameters
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.
RemoteException

removeItem

public void removeItem(CatalogRequest request,
                       CategoryKey categoryKey,
                       ProductItemKey itemKey)
                throws RemoteException,
                       CatalogFinderException,
                       CatalogException
Description copied from interface: CategoryManagerBusiness
Removes an item from the specified category.

Specified by:
removeItem in interface CategoryManagerBusiness
Parameters
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.
RemoteException

getItemCategories

public CategoryKey[] getItemCategories(CatalogRequest request,
                                       ProductItemKey productKey)
                                throws RemoteException,
                                       CatalogFinderException,
                                       CatalogException
Description copied from interface: CategoryManagerBusiness
Gets all the categories that an item is a part of.

Specified by:
getItemCategories in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
productKey - ProductItemKey of the product item concerned.
Returns
An array of category keys.
Throws
CatalogFinderException - if the product item could not be found.
CatalogException - on general error.
RemoteException

getItemCategories

public CategoryKey[][] getItemCategories(CatalogRequest request,
                                         ProductItemKey[] productKeys)
                                  throws RemoteException,
                                         CatalogException
Description copied from interface: CategoryManagerBusiness
Returns an array of arrays of all the categories that items are part of. The order of the arrays returned is the same as the product item keys in the input. In case a product item key does not exist an empty array is returned.

Specified by:
getItemCategories in interface CategoryManagerBusiness
Parameters
request - The catalog request object.
productKeys - Array of ProductItemKeys.
Returns
An array of arrays of category keys.
Throws
CatalogException - on general error.
RemoteException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006 BEA Systems, Inc. All Rights Reserved