oracle.jbo

Interface CategoryManager

All Known Implementing Classes:

CategoryManagerImpl, ClientCategoryManager, ViewObjectCategoryManagerImpl

public interface CategoryManager

Method Summary

Methods

Modifier and Type	Method and Description
void	addCategory(Category category)
Category	findCategory(java.lang.String categoryName)
java.util.List<Category>	getAllCategories()
java.util.Map	getAllCategoriesLookupMap()
Category	getCategory(java.lang.String categoryName)
Category	getDefaultCategory()
java.util.List<Category>	getOrderedCategories(boolean includeDefaultCategory, Category.CategoryType categoryType, LocaleContext locale)
CategoryManagerOwner	getOwner()
boolean	hasCategories()
Category	lookupCategory(java.lang.String categoryName)
Category	removeCategory(java.lang.String categoryName)

Method Detail

getAllCategories

java.util.List<Category> getAllCategories()

Returns:

return the Array of all Categories. This will include the categories from Parents managers also

getAllCategoriesLookupMap

java.util.Map getAllCategoriesLookupMap()

Returns:

return a readonly lookup map that can be used to find categories via get method.

getDefaultCategory

Category getDefaultCategory()

Returns:

the default Category

lookupCategory

Category lookupCategory(java.lang.String categoryName)

addCategory

void addCategory(Category category)

Parameters:

category - Register a new Category with CategoryManager

removeCategory

Category removeCategory(java.lang.String categoryName)

Parameters:

categoryName - Remove the Category from CategoryManager

getOwner

CategoryManagerOwner getOwner()

Returns:

gives the Owner of this CategroyManager

hasCategories

boolean hasCategories()

Returns:

return true if Manager has one or more category

getCategory

Category getCategory(java.lang.String categoryName)

Parameters:

categoryName -

Returns:

return the Category whose name is categoryName This API will throw NoDefException exception if category not found

findCategory

Category findCategory(java.lang.String categoryName)

Parameters:

categoryName -

Returns:

return the Category whose name is categoryName or null if category not found

getOrderedCategories

java.util.List<Category> getOrderedCategories(boolean includeDefaultCategory,
                                            Category.CategoryType categoryType,
                                            LocaleContext locale)

Parameters:

includeDefaultCategory - - "true" means that return list should also include default category . If we pass "false" for this argument , then the return list won't be containing default category

categoryType - - this flag tells what type of categories should the return list contains. If we pass "null", then return list will contain all type of categories. This value should be of enum type Category.CategoryType

locale -

Returns:

will return a list contains Categories arranged by their FieldOrder