com.konakartadmin.blif

Interface AdminCategoryMgrIf

All Known Implementing Classes:

AdminCategoryMgr

public interface AdminCategoryMgrIf

AdminCategoryMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteCategoryTree(int categoryId, int options) Delete the category referenced to by categoryId.
void	deleteSingleCategory(int categoryId) Delete a single category.
boolean	doesCategoryExist(int categoryId) Return true if the category exists.
boolean	doesCategoryExist(int categoryId, java.sql.Connection con) Return true if the category exists.
void	editCategory(AdminCategory cat) Edit the category.
AdminCategory[]	getAllCategories(int languageId) Returns an array of all categories sparsely-populated with Id and name (in the specified language) only.
AdminCategory[]	getAllCategoryImages() Returns an array of all categories sparsely-populated with Id and image name only.
AdminCategory[]	getCategoriesPerProduct(int productId, int languageId) Returns all of the categories that the product belongs to.
AdminCategory[]	getCategoriesPerPromotion(int promotionId, int languageId) Returns all of the categories for the promotion
int[]	getCategoriesPerTagGroup(int tagGroupId) Return an array of Category Ids linked to the specified tag group.
AdminCategoryToTagGroup[]	getCategoriesToTagGroups() Return an array of all of the AdminCategoryToTagGroup records.
AdminCategory	getCategory(int categoryId, boolean getChildren, int languageId)
AdminCategory	getCategory(int categoryId, boolean getChildren, int languageId, java.sql.Connection con)
AdminCategory	getCategory(int categoryId, boolean getChildren, int languageId, java.lang.String storeId)
AdminCategory	getCategory(int categoryId, boolean getChildren, int languageId, java.lang.String storeId, java.sql.Connection con)
AdminCategory	getCategoryFromCache(int catId, int languageId) It returns the category from a hash map created when building the category tree.
int	getCategoryLevel(AdminCategory cat) Method that calculates the level of the category where 0 is the top level, 1 is the first child level etc.
AdminCategory[]	getCategoryTree(int languageId, boolean getNumProducts) Returns an array of top level categories each of which includes an array of child categories etc.
AdminCategory[]	getCategoryTreeFlattenedList(AdminCategory[] catTree) Creates an array of all categories from the Category Tree specified.
AdminCategory[]	getCategoryTreeFromCache(int languageId) It returns the category tree from the cache.
int[]	getChildren(int categoryId) Returns an array of categoryId describing the children of the given category.
AdminCategory[]	getTopLevelCategories(int languageId, AdminDataDescriptor dataDesc) Returns all of the top level categories which are those that have a parentId = 0.
int	insertCategory(AdminCategory cat) Insert a category as a child of the parent category.
void	moveCategory(int categoryId, int newParentId) Move this category to make it a child of the category identified by newParentId

Method Detail

getCategoryTree

AdminCategory[] getCategoryTree(int languageId,
                                boolean getNumProducts)
                         throws java.lang.Exception

Returns an array of top level categories each of which includes an array of child categories etc. so that the category tree structure can be navigated.

Each Category class contains a field that describes how many products exist for that category. This field is calculated if getNumProducts is set to true.

Parameters:

languageId - the languageId

getNumProducts - the getNumProducts

Returns:

Array of Category Objects

Throws:

java.lang.Exception - an unexpected exception

getCategoryTreeFlattenedList

AdminCategory[] getCategoryTreeFlattenedList(AdminCategory[] catTree)

Creates an array of all categories from the Category Tree specified. Rather than just having the top level categories (with their children, and their children's children) as elements it flattens the tree structure to show all categories.

Parameters:

catTree - the catTree

Returns:

Array of all Category Objects

getAllCategories

AdminCategory[] getAllCategories(int languageId)
                          throws java.lang.Exception

Returns an array of all categories sparsely-populated with Id and name (in the specified language) only.

Parameters:

languageId - the languageId

Returns:

Array of sparsely-populated Category Objects

Throws:

java.lang.Exception - an unexpected exception

getAllCategoryImages

AdminCategory[] getAllCategoryImages()
                              throws java.lang.Exception

Returns an array of all categories sparsely-populated with Id and image name only.

Returns:

Array of sparsely-populated Category Objects

Throws:

java.lang.Exception - an unexpected exception

getTopLevelCategories

AdminCategory[] getTopLevelCategories(int languageId,
                                      AdminDataDescriptor dataDesc)
                               throws java.lang.Exception

Returns all of the top level categories which are those that have a parentId = 0. An AdminDataDescriptor object may be supplied in order to add constraints and control the number of categories returned.

Parameters:

languageId - the languageId

dataDesc - the dataDesc

Returns:

Array of Category Objects

Throws:

java.lang.Exception - an unexpected exception

getChildren

int[] getChildren(int categoryId)
           throws java.lang.Exception

Returns an array of categoryId describing the children of the given category. Returns null if there are no children.

Parameters:

categoryId - the categoryId

Returns:

Return an array of categoryId

Throws:

java.lang.Exception - an unexpected exception

getCategory

AdminCategory getCategory(int categoryId,
                          boolean getChildren,
                          int languageId)
                   throws java.lang.Exception

Parameters:

categoryId - the categoryId

getChildren - If true we get all of the children. Children don't have an array of descriptions.

languageId - Needed to determine the language Id of the children

Returns:

Return a fully populated single category object (no children) or null if the category does not exist

Throws:

java.lang.Exception - an unexpected exception

getCategory

AdminCategory getCategory(int categoryId,
                          boolean getChildren,
                          int languageId,
                          java.sql.Connection con)
                   throws java.lang.Exception

Parameters:

categoryId - the categoryId

getChildren - If true we get all of the children. Children don't have an array of descriptions.

languageId - Needed to determine the language Id of the children

con - Connection for transaction

Returns:

Return a fully populated single category object (no children) or null if the category does not exist

Throws:

java.lang.Exception - an unexpected exception

getCategory

AdminCategory getCategory(int categoryId,
                          boolean getChildren,
                          int languageId,
                          java.lang.String storeId)
                   throws java.lang.Exception

Parameters:

categoryId - the categoryId

getChildren - If true we get all of the children. Children don't have an array of descriptions.

languageId - Needed to determine the language Id of the children

storeId - The store id

Returns:

Return a fully populated single category object (no children) or null if the category does not exist

Throws:

java.lang.Exception - an unexpected exception

getCategory

AdminCategory getCategory(int categoryId,
                          boolean getChildren,
                          int languageId,
                          java.lang.String storeId,
                          java.sql.Connection con)
                   throws java.lang.Exception

Parameters:

categoryId - the categoryId

getChildren - If true we get all of the children. Children don't have an array of descriptions.

languageId - Needed to determine the language Id of the children

storeId - The store id

con - Connection for transaction

Returns:

Return a fully populated single category object (no children) or null if the category does not exist

Throws:

java.lang.Exception - an unexpected exception

getCategoryFromCache

AdminCategory getCategoryFromCache(int catId,
                                   int languageId)
                            throws java.lang.Exception

It returns the category from a hash map created when building the category tree. The category contains the children. It's not a clone and so shouldn't be modified.

Parameters:

catId - the catId

languageId - the languageId

Returns:

Returns an Admin category object

Throws:

java.lang.Exception - an unexpected exception

getCategoryTreeFromCache

AdminCategory[] getCategoryTreeFromCache(int languageId)
                                  throws java.lang.Exception

It returns the category tree from the cache. It's not a clone and so shouldn't be modified.

Parameters:

languageId - the languageId

Returns:

Returns the category tree

Throws:

java.lang.Exception - an unexpected exception

getCategoryLevel

int getCategoryLevel(AdminCategory cat)
              throws java.lang.Exception

Method that calculates the level of the category where 0 is the top level, 1 is the first child level etc.

Parameters:

cat - the cat

Returns:

Returns the category level

Throws:

java.lang.Exception - an unexpected exception

doesCategoryExist

boolean doesCategoryExist(int categoryId)
                   throws org.apache.torque.TorqueException,
                          KKAdminException

Return true if the category exists.

Parameters:

categoryId - the categoryId

Returns:

True if the category exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

doesCategoryExist

boolean doesCategoryExist(int categoryId,
                          java.sql.Connection con)
                   throws org.apache.torque.TorqueException,
                          KKAdminException

Return true if the category exists.

Parameters:

categoryId - the categoryId

con - Connection for transaction

Returns:

True if the category exists

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertCategory

int insertCategory(AdminCategory cat)
            throws java.lang.Exception

Insert a category as a child of the parent category. If parent category is 0, we make it a top level category.

Parameters:

cat - the cat

Returns:

Returns the category Id

Throws:

java.lang.Exception - an unexpected exception

editCategory

void editCategory(AdminCategory cat)
           throws java.lang.Exception

Edit the category.

Parameters:

cat - the cat

Throws:

java.lang.Exception - an unexpected exception

deleteCategoryTree

void deleteCategoryTree(int categoryId,
                        int options)
                 throws java.lang.Exception

Delete the category referenced to by categoryId. The child categories and products will either be moved up a level or deleted. If the category is a top level category, then the products will be deleted.

Parameters:

categoryId - the categoryId

options - the options

Throws:

java.lang.Exception - an unexpected exception

deleteSingleCategory

void deleteSingleCategory(int categoryId)
                   throws java.lang.Exception

Delete a single category.

Parameters:

categoryId - the categoryId

Throws:

java.lang.Exception - an unexpected exception

moveCategory

void moveCategory(int categoryId,
                  int newParentId)
           throws java.lang.Exception

Move this category to make it a child of the category identified by newParentId

Parameters:

categoryId - the categoryId

newParentId - the newParentId

Throws:

java.lang.Exception - an unexpected exception

getCategoriesPerPromotion

AdminCategory[] getCategoriesPerPromotion(int promotionId,
                                          int languageId)
                                   throws java.lang.Exception

Returns all of the categories for the promotion

Parameters:

promotionId - the promotionId

languageId - the languageId

Returns:

Array of Category Objects

Throws:

java.lang.Exception - an unexpected exception

getCategoriesPerTagGroup

int[] getCategoriesPerTagGroup(int tagGroupId)
                        throws java.lang.Exception

Return an array of Category Ids linked to the specified tag group. An empty array is returned if no linked Category objects exist.

Parameters:

tagGroupId - The Id of the tag Group

Returns:

Returns an array of Category Ids

Throws:

java.lang.Exception - an unexpected exception

getCategoriesToTagGroups

AdminCategoryToTagGroup[] getCategoriesToTagGroups()
                                            throws java.lang.Exception

Return an array of all of the AdminCategoryToTagGroup records. An empty array is returned if no such records exist.

Returns:

Returns an array of AdminCategoryToTagGroups

Throws:

java.lang.Exception - an unexpected exception

getCategoriesPerProduct

AdminCategory[] getCategoriesPerProduct(int productId,
                                        int languageId)
                                 throws java.lang.Exception

Returns all of the categories that the product belongs to.

Parameters:

productId - the productId

languageId - the languageId

Returns:

Returns an array of categories

Throws:

java.lang.Exception - an unexpected exception