de.hybris.platform.productcockpit.services.catalog

Interface CatalogService

All Known Subinterfaces:

CatalogListService

All Known Implementing Classes:

CatalogListServiceImpl, CatalogServiceImpl

public interface CatalogService

Method Summary

Modifier and Type	Method and Description
void	addToCategories(TypedObject categorizableItem, List<TypedObject> categories) Adds given categorizable item to given categories.
boolean	assignProduct(TypedObject product, CatalogVersionModel catalogVersionModel, CategoryModel removeFromCategory)
boolean	assignProduct(TypedObject product, CategoryModel newSuperCategory, CategoryModel removeFromCategory)
boolean	assignProducts(Collection<TypedObject> products, CategoryModel newSuperCategory, CategoryModel removeFromCategory)
List<CatalogVersionModel>	getAllCatalogVersions(UserModel user) Get all available catalog versions for an user
List<CatalogModel>	getAvailableCatalogs(UserModel user) Get the available catalogs for an user
List<CatalogVersionModel>	getAvailableCatalogVersions() Get the available catalog versions for the current user
CatalogModel	getCatalog(CatalogVersionModel version) Get the catalog for the given catalog version
CatalogVersionModel	getCatalogVersion(CategoryModel category) Get the catalog versions containing the given category
CatalogVersionModel	getCatalogVersion(PK pk) Get the CatalogVersion for a Catalog item, specified by PK
List<CatalogVersionModel>	getCatalogVersions(CatalogModel catalog, UserModel user) Get the catalog versions for a catalog
TypedObject	getCatalogVersionTypedObject(CatalogVersionModel catVer)
List<CategoryModel>	getCategories(CatalogVersionModel version) Get all root categories under a catalog version
List<CategoryModel>	getCategories(CategoryModel category) Get all direct sub-categories for a category
long	getCategoryCount(CatalogVersionModel version) get the number of root categories under a catalog version
long	getCategoryCount(CategoryModel category) Get the number of sub-categories for a category
List<CategoryModel>	getCategoryPath(CategoryModel category) Get a list of categories representing the path from the given category through all supercategories to the root category
int	getItemCount(MacFinderTreeNode wrappedCategory, CatalogVersionModel version, boolean includeSubCategory, MacFinderTreeNode connectedItem)
List<MacFinderTreeNode>	getItems(MacFinderTreeNode wrappedCategory, CatalogVersionModel version, boolean includeSubCategory, MacFinderTreeNode connectedItem) Get the products for a given category.
List<CatalogVersionModel>	getSortedCatalogVersions(UserModel user) Get the available catalog versions for an user in an alternative order
Collection<String>	getSubcategoriesHavingSubcategories(ItemModel item) Get a collection of all non-empty sub-categories for a given category or catalog version
List<TypedObject>	getSupercategories(TypedObject categorizableItem, boolean fromSameCatalogVersionOnly) Returns list of supercategories of the given categorizable item.
boolean	isAssignProductPermitted(TypedObject product, CategoryModel newSuperCategory, CategoryModel removeFromCategory)
boolean	isMoveCategoriesPermitted(Collection<TypedObject> categories, CategoryModel newSuperCategory, CategoryModel removeCategory)
boolean	isMoveCategoryPermitted(CategoryModel category, CategoryModel newSuperCategory, CategoryModel removeCategory)
boolean	moveCategories(Collection<TypedObject> categores, CategoryModel newSuperCategory, CategoryModel removeCategory)
boolean	moveCategory(CategoryModel category, CategoryModel newSuperCategory, CategoryModel removeCategory)
void	removeFromCategories(TypedObject categorizableItem, List<TypedObject> categories) Removes given categorizable item from given categories.
boolean	setAsRootCategory(CategoryModel category)
CatalogVersionModel	wrapCatalogVersion(TypedObject typedObject)
CategoryModel	wrapCategory(TypedObject typedObject)

Method Detail

getAvailableCatalogs

List<CatalogModel> getAvailableCatalogs(UserModel user)

Get the available catalogs for an user

Parameters:

user - the user

Returns:

a list of catalogs

getCatalogVersions

List<CatalogVersionModel> getCatalogVersions(CatalogModel catalog,
                                             UserModel user)

Get the catalog versions for a catalog

Parameters:

catalog - the catalog containing the versions

user - the user

Returns:

a list of catalog versions

getAllCatalogVersions

List<CatalogVersionModel> getAllCatalogVersions(UserModel user)

Get all available catalog versions for an user

Parameters:

user - the user

Returns:

a list of catalog versions

getAvailableCatalogVersions

List<CatalogVersionModel> getAvailableCatalogVersions()

Get the available catalog versions for the current user

Returns:

a list of catalog versions

getSortedCatalogVersions

List<CatalogVersionModel> getSortedCatalogVersions(UserModel user)

Get the available catalog versions for an user in an alternative order

Parameters:

user - the user

Returns:

a list of catalog versions

getCategories

List<CategoryModel> getCategories(CatalogVersionModel version)

Get all root categories under a catalog version

Parameters:

version - the catalog version

Returns:

a list of categories

getCategoryCount

long getCategoryCount(CatalogVersionModel version)

get the number of root categories under a catalog version

Parameters:

version - the catalog version

Returns:

the number of root categories

getCategories

List<CategoryModel> getCategories(CategoryModel category)

Get all direct sub-categories for a category

Parameters:

category - the super-category

Returns:

the list of sub-categories

getCategoryCount

long getCategoryCount(CategoryModel category)

Get the number of sub-categories for a category

Parameters:

category - the category

Returns:

the number of direct sub-categories

getCatalog

CatalogModel getCatalog(CatalogVersionModel version)

Get the catalog for the given catalog version

Parameters:

version - the catalog version

Returns:

the catalog containing the catalog version

getCatalogVersion

CatalogVersionModel getCatalogVersion(CategoryModel category)

Get the catalog versions containing the given category

Parameters:

category - the category

Returns:

the containing catalog version

getCategoryPath

List<CategoryModel> getCategoryPath(CategoryModel category)

Get a list of categories representing the path from the given category through all supercategories to the root category

Parameters:

category - the category

Returns:

a list of categories

getSubcategoriesHavingSubcategories

Collection<String> getSubcategoriesHavingSubcategories(ItemModel item)

Get a collection of all non-empty sub-categories for a given category or catalog version

Parameters:

item - the catalog or catalog version

Returns:

a list of categories

getCatalogVersion

CatalogVersionModel getCatalogVersion(PK pk)

Get the CatalogVersion for a Catalog item, specified by PK

Parameters:

pk - the pk of the item

Returns:

the catalog version if it exists, null otherwise

getItems

List<MacFinderTreeNode> getItems(MacFinderTreeNode wrappedCategory,
                                 CatalogVersionModel version,
                                 boolean includeSubCategory,
                                 MacFinderTreeNode connectedItem)

Get the products for a given category.

Parameters:

wrappedCategory - the category

includeSubCategory - if true, also include products from sub-categories

Returns:

a list of products

getItemCount

int getItemCount(MacFinderTreeNode wrappedCategory,
                 CatalogVersionModel version,
                 boolean includeSubCategory,
                 MacFinderTreeNode connectedItem)

isMoveCategoriesPermitted

boolean isMoveCategoriesPermitted(Collection<TypedObject> categories,
                                  CategoryModel newSuperCategory,
                                  CategoryModel removeCategory)

isMoveCategoryPermitted

boolean isMoveCategoryPermitted(CategoryModel category,
                                CategoryModel newSuperCategory,
                                CategoryModel removeCategory)

isAssignProductPermitted

boolean isAssignProductPermitted(TypedObject product,
                                 CategoryModel newSuperCategory,
                                 CategoryModel removeFromCategory)

moveCategory

boolean moveCategory(CategoryModel category,
                     CategoryModel newSuperCategory,
                     CategoryModel removeCategory)

moveCategories

boolean moveCategories(Collection<TypedObject> categores,
                       CategoryModel newSuperCategory,
                       CategoryModel removeCategory)

setAsRootCategory

boolean setAsRootCategory(CategoryModel category)

assignProduct

boolean assignProduct(TypedObject product,
                      CategoryModel newSuperCategory,
                      CategoryModel removeFromCategory)

assignProducts

boolean assignProducts(Collection<TypedObject> products,
                       CategoryModel newSuperCategory,
                       CategoryModel removeFromCategory)

assignProduct

boolean assignProduct(TypedObject product,
                      CatalogVersionModel catalogVersionModel,
                      CategoryModel removeFromCategory)

wrapCategory

CategoryModel wrapCategory(TypedObject typedObject)

wrapCatalogVersion

CatalogVersionModel wrapCatalogVersion(TypedObject typedObject)

getCatalogVersionTypedObject

TypedObject getCatalogVersionTypedObject(CatalogVersionModel catVer)

getSupercategories

List<TypedObject> getSupercategories(TypedObject categorizableItem,
                                     boolean fromSameCatalogVersionOnly)

Returns list of supercategories of the given categorizable item.

Parameters:

categorizableItem - a categorizable item (product, category..)

fromSameCatalogVersionOnly - if true, only supercategories belonging to the same catalog version as given categorizable item are returned

Returns:

list of supercategories of the given categorizable item

addToCategories

void addToCategories(TypedObject categorizableItem,
                     List<TypedObject> categories)

Adds given categorizable item to given categories.

Parameters:

categorizableItem - the categorizable item to be added

categories - the categories to add to

removeFromCategories

void removeFromCategories(TypedObject categorizableItem,
                          List<TypedObject> categories)

Removes given categorizable item from given categories.

Parameters:

categorizableItem - the categorizable item to be removed

categories - the categories to remove from