Package de.hybris.platform.category.impl

Class DefaultCategoryService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.category.impl.DefaultCategoryService

All Implemented Interfaces:

CategoryService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DefaultCategoryService
extends AbstractBusinessService
implements CategoryService

Default implementation for CategoryService.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultCategoryService()

Method Summary

Modifier and Type	Method	Description
void	disableSubcategoryRemovalCheck()	Disable subcategory removal check.
void	enableSubcategoryRemovalCheck()	Enable subcategory removal check.
Collection<CategoryModel>	getAllSubcategoriesForCategory(CategoryModel category)	Gets all subcategories for category and all subcategories recursively.
Collection<CategoryModel>	getAllSupercategoriesForCategory(CategoryModel category)	Gets the all supercategories for categories.
Collection<CategoryModel>	getCategoriesForCode(String code)	Retrieves for the given code all found CategoryModels.
CategoryModel	getCategory(CatalogVersionModel catalogVersion, String code)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
CategoryModel	getCategory(String code)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
CategoryModel	getCategoryForCode(CatalogVersionModel catalogVersion, String code)	Retrieves the CategoryModel with the specified code which belonging to the specified catalogVersion.
CategoryModel	getCategoryForCode(String code)	Retrieves the CategoryModel with the specific code.
List<CategoryModel>	getCategoryPathForProduct(ProductModel product, Class... includeOnlyCategories)	Gets the category path for product.
List<CategoryModel>	getPath(CategoryModel category)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
List<CategoryModel>	getPathForCategory(CategoryModel category)	Returns the path from root category to the given CategoryModel.
Collection<List<CategoryModel>>	getPathsForCategory(CategoryModel category)	Returns all paths for this CategoryModel.
Collection<CategoryModel>	getRootCategories(CatalogVersionModel catalogVersion)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
Collection<CategoryModel>	getRootCategoriesForCatalogVersion(CatalogVersionModel catalogVersion)	Retrieves the root CategoryModels of the specified CatalogVersionModel.
boolean	isEmpty(CategoryModel category)	Checks if the CategoryModel has product or sub-category.
boolean	isRoot(CategoryModel category)	Checks if the the CategoryModel is a root category (has no super category).
boolean	isSetAllowedPrincipalsRecursivelyDisabled()	Checks if the attribute CategoryConstants.DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY exists in the session and evaluates its value.
boolean	isSubcategoryRemovalCheckDisabled()	Checks if the attribute CategoryConstants.DISABLE_SUBCATEGORY_REMOVALCHECK exists in the session and evaluates its value.
void	setAllowedPrincipalsForAllRelatedCategories(CategoryModel category, List<PrincipalModel> newPrincipals)	Sets the principals for the category and all supercategories and subcategories of passed as parameter category.
void	setAllowedPrincipalsForCategory(CategoryModel category, List<PrincipalModel> newPrincipals)	Sets the principals for the category.
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setCategoryDao(CategoryDao categoryDao)
void	setCategoryPrincipalStrategy(CategoryPrincipalStrategy categoryPrincipalStrategy)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCategoryService

public DefaultCategoryService()

Method Details

disableSubcategoryRemovalCheck

public void disableSubcategoryRemovalCheck()

Description copied from interface: CategoryService

Disable subcategory removal check. This method puts into the session flag CategoryConstants.DISABLE_SUBCATEGORY_REMOVALCHECK with value Boolean.TRUE. This flag is next checked by CategoryRemovalValidator to ensure that category should be checked against possible subcategories during remove.

Specified by:

disableSubcategoryRemovalCheck in interface CategoryService

enableSubcategoryRemovalCheck

public void enableSubcategoryRemovalCheck()

Description copied from interface: CategoryService

Enable subcategory removal check. This method removes flag CategoryConstants.DISABLE_SUBCATEGORY_REMOVALCHECK from the session and each possible remove action on category will always perform check against possible subcategories. Category which has subcategories will be not removed.

Specified by:

enableSubcategoryRemovalCheck in interface CategoryService

isSubcategoryRemovalCheckDisabled

public boolean isSubcategoryRemovalCheckDisabled()

Description copied from interface: CategoryService

Checks if the attribute CategoryConstants.DISABLE_SUBCATEGORY_REMOVALCHECK exists in the session and evaluates its value.

Specified by:

isSubcategoryRemovalCheckDisabled in interface CategoryService

Returns:

true if CategoryConstants.DISABLE_SUBCATEGORY_REMOVALCHECK exists in the session AND the value is true

isSetAllowedPrincipalsRecursivelyDisabled

public boolean isSetAllowedPrincipalsRecursivelyDisabled()

Description copied from interface: CategoryService

Checks if the attribute CategoryConstants.DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY exists in the session and evaluates its value. If the flag is set to false (default) then while setting the principals for a given category, the subcategories and supercategories are updated as well. Copying the prinicpals down to subcategories means mostly replacing them. Pulling the principals up however allows only adding new principals in supercategories, never remove.

Specified by:

isSetAllowedPrincipalsRecursivelyDisabled in interface CategoryService

Returns:

true if CategoryConstants.DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY exists in the session AND the value is true

getCategoriesForCode

public Collection<CategoryModel> getCategoriesForCode(String code)

Description copied from interface: CategoryService

Retrieves for the given code all found CategoryModels.

Specified by:

getCategoriesForCode in interface CategoryService

Parameters:

code - the code of the category.

Returns:

all found CategoryModels or an empty collection if no such category exists

See Also:

• CatalogVersionService.setSessionCatalogVersions(Collection)
• CatalogVersionService.getSessionCatalogVersions()
• CatalogVersionService.addSessionCatalogVersion(CatalogVersionModel)

getCategoryPathForProduct

public List<CategoryModel> getCategoryPathForProduct(ProductModel product,
 Class... includeOnlyCategories)

Description copied from interface: CategoryService

Gets the category path for product.

Specified by:

getCategoryPathForProduct in interface CategoryService

Parameters:

product - the product

includeOnlyCategories - classes which limits resulting path

Returns:

the category path for product

getCategory

@Deprecated(since="ages",
            forRemoval=true)
public CategoryModel getCategory(CatalogVersionModel catalogVersion,
 String code)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Specified by:

getCategory in interface CategoryService

Returns:

the found CategoryModel with the specified code.

getCategory

@Deprecated(since="ages",
            forRemoval=true)
public CategoryModel getCategory(String code)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Specified by:

getCategory in interface CategoryService

Parameters:

code - the code of the to be found CategoryModel

Returns:

the found CategoryModel or null if no category with this code exists

getCategoryForCode

public CategoryModel getCategoryForCode(CatalogVersionModel catalogVersion,
 String code)

Description copied from interface: CategoryService

Retrieves the CategoryModel with the specified code which belonging to the specified catalogVersion.

Specified by:

getCategoryForCode in interface CategoryService

Parameters:

catalogVersion - the CatalogVersionModel where the returned category should be found

code - the code of the CategoryModel

Returns:

the CategoryModel with the specified code and belonging to the CatalogVersionModel

getCategoryForCode

public CategoryModel getCategoryForCode(String code)

Description copied from interface: CategoryService

Retrieves the CategoryModel with the specific code.

Specified by:

getCategoryForCode in interface CategoryService

Parameters:

code - the code of the to be found CategoryModel

Returns:

found CategoryModel

getPath

@Deprecated(since="ages",
            forRemoval=true)
public List<CategoryModel> getPath(CategoryModel category)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Specified by:

getPath in interface CategoryService

Parameters:

category - the CategoryModel

Returns:

the first found path for this category

getPathForCategory

public List<CategoryModel> getPathForCategory(CategoryModel category)

Description copied from interface: CategoryService

Returns the path from root category to the given CategoryModel. To get all super-categories use CategoryModel.getSupercategories().

Specified by:

getPathForCategory in interface CategoryService

Parameters:

category - the CategoryModel

Returns:

the found path for this category

getPathsForCategory

public Collection<List<CategoryModel>> getPathsForCategory(CategoryModel category)

Description copied from interface: CategoryService

Returns all paths for this CategoryModel. Each path is a list of all categories in the path from root to this category.

Specified by:

getPathsForCategory in interface CategoryService

Parameters:

category - the (sub)CategoryModel

Returns:

all paths for this CategoryModel, or empty collection if this category has no super-categories.

getRootCategories

@Deprecated(since="ages",
            forRemoval=true)
public Collection<CategoryModel> getRootCategories(CatalogVersionModel catalogVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Specified by:

getRootCategories in interface CategoryService

Returns:

the found CategoryModels with the specified code.

getRootCategoriesForCatalogVersion

public Collection<CategoryModel> getRootCategoriesForCatalogVersion(CatalogVersionModel catalogVersion)

Description copied from interface: CategoryService

Retrieves the root CategoryModels of the specified CatalogVersionModel.

Specified by:

getRootCategoriesForCatalogVersion in interface CategoryService

Returns:

all found CategoryModels or an empty collection if no root categories can be found

isEmpty

public boolean isEmpty(CategoryModel category)

Description copied from interface: CategoryService

Checks if the CategoryModel has product or sub-category.

Specified by:

isEmpty in interface CategoryService

Parameters:

category - the category to be checked

Returns:

true if the CategoryModel has neither product nor sub-category

isRoot

public boolean isRoot(CategoryModel category)

Description copied from interface: CategoryService

Checks if the the CategoryModel is a root category (has no super category).

Specified by:

isRoot in interface CategoryService

Parameters:

category - the category to be checked

Returns:

true if the CategoryModel is a root category, false otherwise.

setAllowedPrincipalsForCategory

public void setAllowedPrincipalsForCategory(CategoryModel category,
 List<PrincipalModel> newPrincipals)

Description copied from interface: CategoryService

Sets the principals for the category. The new principals will be set to the CategoryModel so that the user rights can be defined specifically.

Specified by:

setAllowedPrincipalsForCategory in interface CategoryService

Parameters:

category - the category where the principals will be applied to

newPrincipals - the list with the new allowed principals of the category

See Also:

• CategoryPrincipalStrategy.replacePrincipalsForCategory(CategoryModel, List)

setAllowedPrincipalsForAllRelatedCategories

public void setAllowedPrincipalsForAllRelatedCategories(CategoryModel category,
 List<PrincipalModel> newPrincipals)

Description copied from interface: CategoryService

Sets the principals for the category and all supercategories and subcategories of passed as parameter category. The new principals will be set to the CategoryModel so that the user rights can be defined specifically.

Specified by:

setAllowedPrincipalsForAllRelatedCategories in interface CategoryService

Parameters:

category - the category where the principals will be applied to

newPrincipals - the list with the new allowed principals of the category

See Also:

• CategoryPrincipalStrategy.replacePrincipalsForCategory(CategoryModel, List)

getAllSubcategoriesForCategory

public Collection<CategoryModel> getAllSubcategoriesForCategory(CategoryModel category)

Description copied from interface: CategoryService

Gets all subcategories for category and all subcategories recursively.

Specified by:

getAllSubcategoriesForCategory in interface CategoryService

Parameters:

category - the category for which subcategories should be obtained

Returns:

the collection of subcategories

getAllSupercategoriesForCategory

public Collection<CategoryModel> getAllSupercategoriesForCategory(CategoryModel category)

Description copied from interface: CategoryService

Gets the all supercategories for categories.

Specified by:

getAllSupercategoriesForCategory in interface CategoryService

Parameters:

category - the category for which supercategories should be obtained

Returns:

the collection of supercategories

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

setCategoryDao

public void setCategoryDao(CategoryDao categoryDao)

setCategoryPrincipalStrategy

public void setCategoryPrincipalStrategy(CategoryPrincipalStrategy categoryPrincipalStrategy)