Package de.hybris.platform.productcockpit.services.catalog.impl

Class CatalogServiceImpl

java.lang.Object

de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

de.hybris.platform.productcockpit.services.catalog.impl.CatalogServiceImpl

All Implemented Interfaces:

CatalogService

Direct Known Subclasses:

CatalogListServiceImpl

public class CatalogServiceImpl
extends AbstractServiceImpl
implements CatalogService

Field Summary

Fields inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

modelService, typeService

Constructor Summary

Constructors

Constructor	Description
CatalogServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addToCategories(TypedObject categorizableItem, java.util.List<TypedObject> categories)	Adds given categorizable item to given categories.
boolean	assignProduct(TypedObject product, CatalogVersionModel catalogVersionModel, CategoryModel removeFromCategory)	Assigns product to catalog version
boolean	assignProduct(TypedObject product, CategoryModel newSuperCategory, CategoryModel removeFromCategory)	Assigns product to category
boolean	assignProducts(java.util.Collection<TypedObject> products, CategoryModel newSuperCategory, CategoryModel oldSuperCategory)	Assigns products to category
java.util.List<CatalogVersionModel>	getAllCatalogVersions(UserModel u)	Get all available catalog versions for an user
java.util.Collection<CategoryModel>	getAllSupercategories(CategoryModel category)
java.util.List<CatalogModel>	getAvailableCatalogs(UserModel u)	Get the available catalogs for an user
java.util.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
java.util.List<CatalogVersionModel>	getCatalogVersions(CatalogModel catalog, UserModel u)	Get the catalog versions for a catalog
TypedObject	getCatalogVersionTypedObject(CatalogVersionModel catVer)	Converts catalog version into TypedObject
java.util.List<CategoryModel>	getCategories(CatalogVersionModel version)	Get all root categories under a catalog version
java.util.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
java.util.List<CategoryModel>	getCategoryPath(CategoryModel category)	Get a list of categories representing the path from the given category through all supercategories to the root category
protected java.util.Collection<java.util.List<Category>>	getCategoryPaths(Category category)
int	getItemCount(MacFinderTreeNode wrappedCategory, CatalogVersionModel version, boolean includeSubCategory, MacFinderTreeNode connectedItem)	Counts subitems in MacFinder tree for specified node.
java.util.List<MacFinderTreeNode>	getItems(MacFinderTreeNode wrappedCategory, CatalogVersionModel version, boolean includSubCategory, MacFinderTreeNode connectedItem)	Get the products for a given category.
protected java.util.Collection<Product>	getProducts(Category category)
protected java.util.List<ProductModel>	getProducts(CategoryModel category)
java.util.List<CatalogVersionModel>	getSortedCatalogVersions(UserModel u)	Get the available catalog versions for an user in an alternative order
java.util.Collection<java.lang.String>	getSubcategoriesHavingSubcategories(ItemModel item)	Get a collection of all non-empty sub-categories for a given category or catalog version
java.util.List<TypedObject>	getSupercategories(TypedObject categorizableItem, boolean fromSameCatalogVersionOnly)	Returns list of supercategories of the given categorizable item.
UIAccessRightService	getUiAccessRightService()
protected boolean	isAssignCatalogVersionPermitted(TypedObject product)
boolean	isAssignProductPermitted(TypedObject product, CategoryModel newSuperCategory, CategoryModel removeFromCategory)	Checks if user is allowed to assing product to a category
protected boolean	isAssignProductsPermitted(java.util.Collection<TypedObject> products, CategoryModel newSuperCategory, CategoryModel removeFromCategory)
protected boolean	isAssignProductsPermitted(java.util.Collection<TypedObject> products, CategoryModel newSuperCategory, java.util.List<CategoryModel> removeFromCategories)
boolean	isMoveCategoriesPermitted(java.util.Collection<TypedObject> categories, CategoryModel newSuperCategory, CategoryModel removeFromCategory)	Checks if user is allowed to move categories from one to other
boolean	isMoveCategoryPermitted(CategoryModel category, CategoryModel newSuperCategory, CategoryModel removeCategory)	Checks if user is allowed to move category from one to other
boolean	moveCategories(java.util.Collection<TypedObject> categories, CategoryModel newSuperCategory, CategoryModel removeCategory)	Moves categories from one to other
boolean	moveCategory(CategoryModel category, CategoryModel newSuperCategory, CategoryModel removeCategory)	Moves category from one to other
void	removeFromCategories(TypedObject categorizableItem, java.util.List<TypedObject> categories)	Removes given categorizable item from given categories.
boolean	setAsRootCategory(CategoryModel category)	Marks a category as root
void	setCatalogService(CatalogService catalogService)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionService(SessionService sessionService)
void	setUiAccessRightService(UIAccessRightService accessService)
void	setUserService(UserService userService)
CatalogVersionModel	wrapCatalogVersion(TypedObject typedObject)	Extracts catalog version model from provided typedObject
CategoryModel	wrapCategory(TypedObject typedObject)	Extracts category model from provided typedObject

Methods inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

getEnum, getEnums, getLocalizedLabel, getLocalizedLabel, getModelService, getTypeService, setCockpitTypeService, setLabelResolver, setModelService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CatalogServiceImpl

public CatalogServiceImpl()

Method Detail

getAvailableCatalogs

public java.util.List<CatalogModel> getAvailableCatalogs(UserModel u)

Description copied from interface: CatalogService

Get the available catalogs for an user

Specified by:

getAvailableCatalogs in interface CatalogService

Parameters:

u - the user

Returns:

a list of catalogs

getCatalogVersions

public java.util.List<CatalogVersionModel> getCatalogVersions(CatalogModel catalog,
                                                              UserModel u)

Description copied from interface: CatalogService

Get the catalog versions for a catalog

Specified by:

getCatalogVersions in interface CatalogService

Parameters:

catalog - the catalog containing the versions

u - the user

Returns:

a list of catalog versions

getAllCatalogVersions

public java.util.List<CatalogVersionModel> getAllCatalogVersions(UserModel u)

Description copied from interface: CatalogService

Get all available catalog versions for an user

Specified by:

getAllCatalogVersions in interface CatalogService

Parameters:

u - the user

Returns:

a list of catalog versions

getSortedCatalogVersions

public java.util.List<CatalogVersionModel> getSortedCatalogVersions(UserModel u)

Description copied from interface: CatalogService

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

Specified by:

getSortedCatalogVersions in interface CatalogService

Parameters:

u - the user

Returns:

a list of catalog versions

getSubcategoriesHavingSubcategories

public java.util.Collection<java.lang.String> getSubcategoriesHavingSubcategories(ItemModel item)

Description copied from interface: CatalogService

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

Specified by:

getSubcategoriesHavingSubcategories in interface CatalogService

Parameters:

item - the catalog or catalog version

Returns:

a list of categories

getCategories

public java.util.List<CategoryModel> getCategories(CatalogVersionModel version)

Description copied from interface: CatalogService

Get all root categories under a catalog version

Specified by:

getCategories in interface CatalogService

Parameters:

version - the catalog version

Returns:

a list of categories

getCategories

public java.util.List<CategoryModel> getCategories(CategoryModel category)

Description copied from interface: CatalogService

Get all direct sub-categories for a category

Specified by:

getCategories in interface CatalogService

Parameters:

category - the super-category

Returns:

the list of sub-categories

getCatalog

public CatalogModel getCatalog(CatalogVersionModel version)

Description copied from interface: CatalogService

Get the catalog for the given catalog version

Specified by:

getCatalog in interface CatalogService

Parameters:

version - the catalog version

Returns:

the catalog containing the catalog version

getCatalogVersion

public CatalogVersionModel getCatalogVersion(CategoryModel category)

Description copied from interface: CatalogService

Get the catalog versions containing the given category

Specified by:

getCatalogVersion in interface CatalogService

Parameters:

category - the category

Returns:

the containing catalog version

getAllSupercategories

public java.util.Collection<CategoryModel> getAllSupercategories(CategoryModel category)

getCategoryPath

public java.util.List<CategoryModel> getCategoryPath(CategoryModel category)

Description copied from interface: CatalogService

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

Specified by:

getCategoryPath in interface CatalogService

Parameters:

category - the category

Returns:

a list of categories

getAvailableCatalogVersions

public java.util.List<CatalogVersionModel> getAvailableCatalogVersions()

Description copied from interface: CatalogService

Get the available catalog versions for the current user

Specified by:

getAvailableCatalogVersions in interface CatalogService

Returns:

a list of catalog versions

getCategoryCount

public long getCategoryCount(CatalogVersionModel version)

Description copied from interface: CatalogService

get the number of root categories under a catalog version

Specified by:

getCategoryCount in interface CatalogService

Parameters:

version - the catalog version

Returns:

the number of root categories

getCategoryCount

public long getCategoryCount(CategoryModel category)

Description copied from interface: CatalogService

Get the number of sub-categories for a category

Specified by:

getCategoryCount in interface CatalogService

Parameters:

category - the category

Returns:

the number of direct sub-categories

getItems

public java.util.List<MacFinderTreeNode> getItems(MacFinderTreeNode wrappedCategory,
                                                  CatalogVersionModel version,
                                                  boolean includSubCategory,
                                                  MacFinderTreeNode connectedItem)

Description copied from interface: CatalogService

Get the products for a given category.

Specified by:

getItems in interface CatalogService

Parameters:

wrappedCategory - the category

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

Returns:

a list of products

getItemCount

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

Description copied from interface: CatalogService

Counts subitems in MacFinder tree for specified node.

Specified by:

getItemCount in interface CatalogService

Parameters:

wrappedCategory - category tree node

version - catalog version

includeSubCategory - true if subitems in subcategories should also be counted

connectedItem - item which subitems should be counted

Returns:

number of subitems matching requirements

See Also:

AbstractDao.getItemCount(de.hybris.platform.jalo.Item, de.hybris.platform.catalog.jalo.CatalogVersion, boolean)

getCatalogVersion

public CatalogVersionModel getCatalogVersion(PK pk)

Description copied from interface: CatalogService

Get the CatalogVersion for a Catalog item, specified by PK

Specified by:

getCatalogVersion in interface CatalogService

Parameters:

pk - the pk of the item

Returns:

the catalog version if it exists, null otherwise

assignProduct

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

Description copied from interface: CatalogService

Assigns product to catalog version

Specified by:

assignProduct in interface CatalogService

Parameters:

product - product to be assigned

catalogVersionModel - new catalog version

removeFromCategory - parent category from which product should be removed

Returns:

true if moving was successfully performed

assignProduct

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

Description copied from interface: CatalogService

Assigns product to category

Specified by:

assignProduct in interface CatalogService

Parameters:

product - product to be assigned

newSuperCategory - new parent category

removeFromCategory - parent category from which product should be removed

Returns:

true if moving was successfully performed

assignProducts

public boolean assignProducts(java.util.Collection<TypedObject> products,
                              CategoryModel newSuperCategory,
                              CategoryModel oldSuperCategory)

Description copied from interface: CatalogService

Assigns products to category

Specified by:

assignProducts in interface CatalogService

Parameters:

products - products to be assigned

newSuperCategory - new parent category

oldSuperCategory - parent category from which products should be removed

Returns:

true if moving was successfully performed

moveCategories

public boolean moveCategories(java.util.Collection<TypedObject> categories,
                              CategoryModel newSuperCategory,
                              CategoryModel removeCategory)

Description copied from interface: CatalogService

Moves categories from one to other

Specified by:

moveCategories in interface CatalogService

Parameters:

categories - categories to be moved

newSuperCategory - new parent category for categories

removeCategory - parent category from which categories should be removed

Returns:

true if moving was successfully performed

moveCategory

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

Description copied from interface: CatalogService

Moves category from one to other

Specified by:

moveCategory in interface CatalogService

Parameters:

category - category to be moved

newSuperCategory - new parent category for category

removeCategory - parent category from which category should be removed

Returns:

true if moving was successfully performed

isAssignProductPermitted

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

Description copied from interface: CatalogService

Checks if user is allowed to assing product to a category

Specified by:

isAssignProductPermitted in interface CatalogService

Parameters:

product - product to be assigned

newSuperCategory - new parent category

removeFromCategory - parent category from which product should be removed

Returns:

true if allowed

isAssignCatalogVersionPermitted

protected boolean isAssignCatalogVersionPermitted(TypedObject product)

getCategoryPaths

protected java.util.Collection<java.util.List<Category>> getCategoryPaths(Category category)

getProducts

protected java.util.Collection<Product> getProducts(Category category)

getProducts

protected java.util.List<ProductModel> getProducts(CategoryModel category)

isAssignProductsPermitted

protected boolean isAssignProductsPermitted(java.util.Collection<TypedObject> products,
                                            CategoryModel newSuperCategory,
                                            CategoryModel removeFromCategory)

isAssignProductsPermitted

protected boolean isAssignProductsPermitted(java.util.Collection<TypedObject> products,
                                            CategoryModel newSuperCategory,
                                            java.util.List<CategoryModel> removeFromCategories)

isMoveCategoriesPermitted

public boolean isMoveCategoriesPermitted(java.util.Collection<TypedObject> categories,
                                         CategoryModel newSuperCategory,
                                         CategoryModel removeFromCategory)

Description copied from interface: CatalogService

Checks if user is allowed to move categories from one to other

Specified by:

isMoveCategoriesPermitted in interface CatalogService

Parameters:

categories - categories to be moved

newSuperCategory - new parent category for categories

removeFromCategory - parent category from which categories should be removed

Returns:

true if allowed

isMoveCategoryPermitted

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

Description copied from interface: CatalogService

Checks if user is allowed to move category from one to other

Specified by:

isMoveCategoryPermitted in interface CatalogService

Parameters:

category - category to be moved

newSuperCategory - new parent category for category

removeCategory - parent category from which category should be removed

Returns:

true if allowed

setAsRootCategory

public boolean setAsRootCategory(CategoryModel category)

Description copied from interface: CatalogService

Marks a category as root

Specified by:

setAsRootCategory in interface CatalogService

Parameters:

category - root category

Returns:

true is category was successfully marked as root

wrapCategory

public CategoryModel wrapCategory(TypedObject typedObject)

Description copied from interface: CatalogService

Extracts category model from provided typedObject

Specified by:

wrapCategory in interface CatalogService

Parameters:

typedObject - object to extract category from

Returns:

category extracted or null if @typedObject is not category

wrapCatalogVersion

public CatalogVersionModel wrapCatalogVersion(TypedObject typedObject)

Description copied from interface: CatalogService

Extracts catalog version model from provided typedObject

Specified by:

wrapCatalogVersion in interface CatalogService

Parameters:

typedObject - object to extract catalog version from

Returns:

catalog version extracted or null if @typedObject is not catalog version

getCatalogVersionTypedObject

public TypedObject getCatalogVersionTypedObject(CatalogVersionModel catVer)

Description copied from interface: CatalogService

Converts catalog version into TypedObject

Specified by:

getCatalogVersionTypedObject in interface CatalogService

Parameters:

catVer - catalog version to be converted

Returns:

converted catalog version

getSupercategories

public java.util.List<TypedObject> getSupercategories(TypedObject categorizableItem,
                                                      boolean fromSameCatalogVersionOnly)

Description copied from interface: CatalogService

Returns list of supercategories of the given categorizable item.

Specified by:

getSupercategories in interface CatalogService

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

public void addToCategories(TypedObject categorizableItem,
                            java.util.List<TypedObject> categories)

Description copied from interface: CatalogService

Adds given categorizable item to given categories.

Specified by:

addToCategories in interface CatalogService

Parameters:

categorizableItem - the categorizable item to be added

categories - the categories to add to

removeFromCategories

public void removeFromCategories(TypedObject categorizableItem,
                                 java.util.List<TypedObject> categories)

Description copied from interface: CatalogService

Removes given categorizable item from given categories.

Specified by:

removeFromCategories in interface CatalogService

Parameters:

categorizableItem - the categorizable item to be removed

categories - the categories to remove from

setUiAccessRightService

public void setUiAccessRightService(UIAccessRightService accessService)

getUiAccessRightService

public UIAccessRightService getUiAccessRightService()

setSessionService

public void setSessionService(SessionService sessionService)

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)

setCatalogService

public void setCatalogService(CatalogService catalogService)

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

setUserService

public void setUserService(UserService userService)