Package de.hybris.platform.category.jalo

Class Category

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.category.jalo.GeneratedCategory

de.hybris.platform.category.jalo.Category

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedClassificationClass, GeneratedConfigurationCategory, GeneratedVariantCategory, GeneratedVariantValueCategory

public class Category
extends GeneratedCategory

This class represents a simple category, which could have assigned subcategories, products, pictures and thumbnails.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLE_CYCLIC_CHECKS	Deprecated. since ages - please use Constants.DISABLED_CYCLIC_CHECKS instead
static final String	DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY	SessionContext attribute flag for set allowed principals.
static final String	DISABLE_SUBCATEGORY_REMOVALCHECK	SessionContext attribute flag for disabling the subcategory check when removing category

Fields inherited from class de.hybris.platform.category.jalo.GeneratedCategory

ALLOWEDPRINCIPALS, CATALOG, CATALOGVERSION, CATEGORIES, CATEGORY2KEYWORDRELATION_MARKMODIFIED, CATEGORY2KEYWORDRELATION_SRC_ORDERED, CATEGORY2KEYWORDRELATION_TGT_ORDERED, CATEGORY2PRINCIPALRELATION_MARKMODIFIED, CATEGORY2PRINCIPALRELATION_SRC_ORDERED, CATEGORY2PRINCIPALRELATION_TGT_ORDERED, CATEGORYCATEGORYRELATION_MARKMODIFIED, CATEGORYCATEGORYRELATION_SRC_ORDERED, CATEGORYCATEGORYRELATION_TGT_ORDERED, CATEGORYMEDIARELATION_MARKMODIFIED, CATEGORYMEDIARELATION_SRC_ORDERED, CATEGORYMEDIARELATION_TGT_ORDERED, CATEGORYPRODUCTRELATION_MARKMODIFIED, CATEGORYPRODUCTRELATION_SRC_ORDERED, CATEGORYPRODUCTRELATION_TGT_ORDERED, CODE, DATA_SHEET, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, DETAIL, KEYWORDS, LOGO, MEDIAS, NAME, NORMAL, ORDER, OTHERS, PICTURE, PRODUCTS, SUPERCATEGORIES, THUMBNAIL, THUMBNAILS

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
Category()

Method Summary

Modifier and Type	Method	Description
void	addProduct(Product product)	Deprecated. since ages
void	addProduct(Product product, int position, boolean shift)	Deprecated. since ages
void	addProduct(SessionContext ctx, Product product)	Deprecated. since ages
void	addProduct(SessionContext ctx, Product product, int position, boolean shift)	Deprecated. since ages
void	addProducts(SessionContext ctx, Collection<Product> products)	Deprecated. since ages
void	addProducts(Collection<Product> products)	Deprecated. since ages
void	addSubcategories(SessionContext ctx, Collection<Category> categories)	Deprecated. since ages
void	addSubcategories(Collection<Category> categories)	Deprecated. since ages
void	addSubcategory(Category category)	Deprecated. since ages
void	addSubcategory(SessionContext ctx, Category category)	Deprecated. since ages
void	addSupercategories(SessionContext ctx, Collection<Category> categories)	Deprecated. since ages
void	addSupercategories(Collection<Category> categories)	Deprecated. since ages
void	addSupercategory(Category category)	Deprecated. since ages
void	addSupercategory(SessionContext ctx, Category category)	Deprecated. since ages
void	addToCategories(SessionContext ctx, Category cat)	Deprecated. since ages
void	addToSupercategories(SessionContext ctx, Category cat)	Deprecated. since ages
protected void	assertNoCycle(SessionContext ctx, Collection<Category> toAddTo, Collection<Category> toCheck, boolean sub)	Deprecated. since ages
protected void	checkRemovable(SessionContext ctx)	Deprecated. since ages - covered byCategoryRemovalValidator.
boolean	containsProducts()	Deprecated. since ages - use ProductService.containsProductsForCategory(de.hybris.platform.category.model.CategoryModel) instead.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Deprecated. since ages
protected boolean	disableChecks(SessionContext ctx)	Deprecated. since ages
int	getAllProductsCount()	Deprecated. since ages - use ProductService.getAllProductsCountForCategory(de.hybris.platform.category.model.CategoryModel) instead.
Collection<Category>	getAllSubcategories()	Deprecated. since ages - useCategoryModel.getAllSubcategories() instead.
Collection<Category>	getAllSubcategories(SessionContext ctx)	Deprecated. since ages - useCategoryModel.getAllSubcategories() instead.
int	getAllSubcategoriesCount()	Deprecated. since ages - useCategoryModel.getAllSubcategories() and method size() on result instead.
Collection<Category>	getAllSupercategories()	Deprecated. since ages - useCategoryModel.getAllSupercategories() instead.
Collection<Category>	getAllSupercategories(SessionContext ctx)	Deprecated. since ages - useCategoryModel.getAllSubcategories() instead.
String	getCode()	Deprecated. since ages
List<Category>	getPath()	Deprecated. since ages - use CategoryService.getPathForCategory(de.hybris.platform.category.model.CategoryModel) instead.
Collection<List<Category>>	getPaths()	Deprecated. since ages - use CategoryService.getPathsForCategory(de.hybris.platform.category.model.CategoryModel) instead.
long	getProductsCount()	Deprecated. since ages - use ProductService.getProductsCountForCategory(de.hybris.platform.category.model.CategoryModel) instead.
Collection<Category>	getSubcategories()	Deprecated. since ages
List<Category>	getSubcategories(SessionContext ctx)	Deprecated. since ages
long	getSubcategoryCount()	Deprecated. since ages
Category	getSupercategory()	Deprecated. since ages
Category	getSupercategory(SessionContext ctx)	Deprecated. since ages
long	getSupercategoryCount()	Deprecated. since ages
boolean	isEmpty()	Deprecated. since ages - use CategoryService.isEmpty(de.hybris.platform.category.model.CategoryModel) instead.
Boolean	isRoot()	Deprecated. since ages - use CategoryService.isRoot(de.hybris.platform.category.model.CategoryModel) instead.
Boolean	isRoot(SessionContext ctx)	Deprecated. since ages - use CategoryService.isRoot(de.hybris.platform.category.model.CategoryModel) instead.
boolean	isRootAsPrimitive()
boolean	isRootAsPrimitive(SessionContext ctx)
protected boolean	isSetAllowedPrincipalsRecursivelyDisabled(SessionContext ctx)	Deprecated. since ages - covered byCategoryPrincipalStrategy.
protected boolean	isSubcategoryRemovalCheckDisabled(SessionContext ctx)	Deprecated. since ages - covered byCategoryRemovalValidator.
protected void	pullUpAllowedPrincipalInternals(SessionContext ctx, Category superCat, List<Principal> newOnes)	Deprecated. since ages - covered byCategoryPrincipalStrategy.
void	removeProduct(Product product)	Deprecated. since ages
void	removeProduct(SessionContext ctx, Product product)	Deprecated. since ages
void	removeProducts(SessionContext ctx, Collection<Product> products)	Deprecated. since ages
void	removeProducts(Collection<Product> products)	Deprecated. since ages
void	removeSubcategories(SessionContext ctx, Collection<Category> categories)	Deprecated. since ages
void	removeSubcategories(Collection<Category> categories)	Deprecated. since ages
void	removeSubcategory(Category category)	Deprecated. since ages
void	removeSubcategory(SessionContext ctx, Category category)	Deprecated. since ages
void	removeSupercategories(SessionContext ctx, Collection<Category> categories)	Deprecated. since ages
void	removeSupercategories(Collection<Category> categories)	Deprecated. since ages
void	removeSupercategory(Category category)	Deprecated. since ages
void	removeSupercategory(SessionContext ctx, Category category)	Deprecated. since ages
void	setAllowedPrincipals(SessionContext ctx, List<Principal> newOnes)	Deprecated. since ages - use CategoryService.setAllowedPrincipalsForCategory(de.hybris.platform.category.model.CategoryModel, List) instead.
void	setAllowedPrincipalsOnlyForPassedCategory(SessionContext ctx, List<Principal> value)
void	setCategories(Category... categories)	Deprecated. since ages
void	setCategories(SessionContext ctx, Category... categories)	Deprecated. since ages
void	setCategories(SessionContext ctx, List<Category> categories)	Deprecated. since ages
void	setSubcategories(SessionContext ctx, List<Category> subcategories)	Deprecated. since ages
void	setSubcategories(List<Category> subcategories)	Deprecated. since ages
void	setSupercategories(Category... superCategories)	Deprecated. since ages
void	setSupercategories(SessionContext ctx, Category... superCategories)	Deprecated. since ages
void	setSupercategories(SessionContext ctx, List<Category> categories)	Deprecated. since ages
String	toString()	Returns the String representation of this item.

Methods inherited from class de.hybris.platform.category.jalo.GeneratedCategory

addToAllowedPrincipals, addToAllowedPrincipals, addToCategories, addToKeywords, addToKeywords, addToMedias, addToMedias, addToProducts, addToProducts, addToSupercategories, getAllDescription, getAllDescription, getAllKeywords, getAllKeywords, getAllName, getAllName, getAllowedPrincipals, getAllowedPrincipals, getAllowedPrincipalsCount, getAllowedPrincipalsCount, getCatalogVersion, getCatalogVersion, getCategories, getCategories, getCategoriesCount, getCategoriesCount, getCode, getData_sheet, getData_sheet, getDefaultAttributeModes, getDescription, getDescription, getDetail, getDetail, getKeywords, getKeywords, getKeywordsCount, getKeywordsCount, getKeywordsCount, getKeywordsCount, getLogo, getLogo, getMedias, getMedias, getMediasCount, getMediasCount, getName, getName, getNormal, getNormal, getOrder, getOrder, getOrderAsPrimitive, getOrderAsPrimitive, getOthers, getOthers, getPicture, getPicture, getProducts, getProducts, getProductsCount, getSupercategories, getSupercategories, getSupercategoriesCount, getSupercategoriesCount, getThumbnail, getThumbnail, getThumbnails, getThumbnails, isMarkModifiedDisabled, removeFromAllowedPrincipals, removeFromAllowedPrincipals, removeFromCategories, removeFromCategories, removeFromKeywords, removeFromKeywords, removeFromMedias, removeFromMedias, removeFromProducts, removeFromProducts, removeFromSupercategories, removeFromSupercategories, setAllDescription, setAllDescription, setAllKeywords, setAllKeywords, setAllName, setAllName, setAllowedPrincipals, setCatalogVersion, setCatalogVersion, setCategories, setCode, setCode, setData_sheet, setData_sheet, setDescription, setDescription, setDetail, setDetail, setKeywords, setKeywords, setLogo, setLogo, setMedias, setMedias, setName, setName, setNormal, setNormal, setOrder, setOrder, setOrder, setOrder, setOthers, setOthers, setPicture, setPicture, setProducts, setProducts, setSupercategories, setThumbnail, setThumbnail, setThumbnails, setThumbnails

Methods inherited from class de.hybris.platform.jalo.GenericItem

getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, getRelatedItems, setRelatedItems

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPartOfRemovedSessionMarker, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, suppressRelation, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DISABLE_SUBCATEGORY_REMOVALCHECK

public static final String DISABLE_SUBCATEGORY_REMOVALCHECK

SessionContext attribute flag for disabling the subcategory check when removing category

See Also:

• Constant Field Values

DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY

public static final String DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY

SessionContext attribute flag for set allowed principals. If the flag is enabled only for the given category the principals are set

See Also:

• Constant Field Values

DISABLE_CYCLIC_CHECKS

@Deprecated(since="ages",
            forRemoval=false)
public static final String DISABLE_CYCLIC_CHECKS

Deprecated.

since ages - please use Constants.DISABLED_CYCLIC_CHECKS instead

Session attribute to disable checking for cyclic structures. Since cyclic structures are not supported by the category model the caller has to do own checking!

 SessionContext myCtx = jaloSesson.createSessionContext();
 myCtx.setAttribute(Constants.DISABLE_CYCLIC_CHECKS, Boolean.TRUE);
 // now this will not raise an error :
 category.addToSubcategory(category.getSuperCategory());
 

Since:

1.31

Constructor Details

Category

public Category()

Method Details

createItem

@Deprecated(since="ages",
            forRemoval=false)
protected Item createItem(SessionContext ctx,
 ComposedType type,
 Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Deprecated.

since ages

create the item you can delete this method if you don't want to intercept the creation of this item

Overrides:

createItem in class GenericItem

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

toString

public String toString()

Description copied from class: Item

Returns the String representation of this item. This is by default the representation of the primary key of this item.

Overrides:

toString in class Item

Returns:

the String representation of this item.

getCode

@Deprecated(since="ages",
            forRemoval=false)
public String getCode()

Deprecated.

since ages

Description copied from class: GeneratedCategory

Generated method - Getter of the Category.code attribute.

Overrides:

getCode in class GeneratedCategory

Returns:

the code - Code

getSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Category> getSubcategories()

Deprecated.

since ages

Gets subcategories of this category.

Returns:

subcategories of this category

getSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public List<Category> getSubcategories(SessionContext ctx)

Deprecated.

since ages

Gets subcategories of this category.

Parameters:

ctx - session context

Returns:

subcategories of this category

getSubcategoryCount

@Deprecated(since="ages",
            forRemoval=false)
public long getSubcategoryCount()

Deprecated.

since ages

Returns the amount of subcategories of this category. This method should be preferred over getSubcategories().size() since it does not actually load the subcategories.

getAllSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Category> getAllSubcategories()

Deprecated.

since ages - useCategoryModel.getAllSubcategories() instead.

Gets all subcategories of this category. This includes its own subcategories and all their subcategories.

Returns:

all categories below this category

Since:

1.3.1

getAllSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Category> getAllSubcategories(SessionContext ctx)

Deprecated.

since ages - useCategoryModel.getAllSubcategories() instead.

Gets all subcategories of this category. This includes its own subcategories and all their subcategories.

Parameters:

ctx - session context

Returns:

all categories below this category

Since:

1.3.1

getAllSubcategoriesCount

@Deprecated(since="ages",
            forRemoval=false)
public int getAllSubcategoriesCount()

Deprecated.

since ages - useCategoryModel.getAllSubcategories() and method size() on result instead.

Counts all subcategories of this category excluding duplicately linked categories.

Since:

2.10

getAllProductsCount

@Deprecated(since="ages",
            forRemoval=false)
public int getAllProductsCount()

Deprecated.

since ages - use ProductService.getAllProductsCountForCategory(de.hybris.platform.category.model.CategoryModel) instead.

Counts all products of this category excluding double linked products. This includes all own products and products belonging to any sub category.

Since:

2.10

setCategories

@Deprecated(since="ages",
            forRemoval=false)
public void setCategories(SessionContext ctx,
 List<Category> categories)
                   throws JaloInvalidParameterException

Deprecated.

since ages

Superclass method overridden to check cyclic dependencies.

Checking may be disabled using session context attribute Constants.DISABLE_CYCLIC_CHECKS.

Overrides:

setCategories in class GeneratedCategory

categories - the categories - Sub Categories

Throws:

JaloInvalidParameterException - if any of these categories is already super category of this categroy

setCategories

@Deprecated(since="ages",
            forRemoval=false)
public void setCategories(Category... categories)

Deprecated.

since ages

setCategories

@Deprecated(since="ages",
            forRemoval=false)
public void setCategories(SessionContext ctx,
 Category... categories)

Deprecated.

since ages

addToCategories

@Deprecated(since="ages",
            forRemoval=false)
public void addToCategories(SessionContext ctx,
 Category cat)
                     throws JaloInvalidParameterException

Deprecated.

since ages

Superclass method overridden to check cyclic dependencies.

Checking may be disabled using session context attribute Constants.DISABLE_CYCLIC_CHECKS.

Overrides:

addToCategories in class GeneratedCategory

cat - the item to add to categories - Sub Categories

Throws:

JaloInvalidParameterException - if the new category is already super category of this category

setSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void setSupercategories(SessionContext ctx,
 List<Category> categories)
                        throws JaloInvalidParameterException

Deprecated.

since ages

Superclass method overridden to check cyclic dependencies.

Checking may be disabled using session context attribute Constants.DISABLE_CYCLIC_CHECKS.

Overrides:

setSupercategories in class GeneratedCategory

categories - the supercategories - Super Categories

Throws:

JaloInvalidParameterException - if any of these categories is already subcategory of this category

setSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void setSupercategories(Category... superCategories)

Deprecated.

since ages

setSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void setSupercategories(SessionContext ctx,
 Category... superCategories)

Deprecated.

since ages

addToSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void addToSupercategories(SessionContext ctx,
 Category cat)
                          throws JaloInvalidParameterException

Deprecated.

since ages

Superclass method overridden to check cyclic dependencies.

Checking may be disabled using session context attribute Constants.DISABLE_CYCLIC_CHECKS.

Overrides:

addToSupercategories in class GeneratedCategory

cat - the item to add to supercategories - Super Categories

Throws:

JaloInvalidParameterException - if the new category is already subcategory of this category

disableChecks

@Deprecated(since="ages",
            forRemoval=false)
protected boolean disableChecks(SessionContext ctx)

Deprecated.

since ages

assertNoCycle

@Deprecated(since="ages",
            forRemoval=false)
protected void assertNoCycle(SessionContext ctx,
 Collection<Category> toAddTo,
 Collection<Category> toCheck,
 boolean sub)
                      throws JaloInvalidParameterException

Deprecated.

since ages

Throws:

JaloInvalidParameterException

setSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void setSubcategories(List<Category> subcategories)

Deprecated.

since ages

Sets the subcategories of this category.

Parameters:

subcategories - subcategories to set

setSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void setSubcategories(SessionContext ctx,
 List<Category> subcategories)

Deprecated.

since ages

Sets the subcategories of this category.

Parameters:

ctx - session context

subcategories - subcategories to set

addSubcategory

@Deprecated(since="ages",
            forRemoval=false)
public void addSubcategory(Category category)

Deprecated.

since ages

Adds given category to subcategories of this category.

Parameters:

category - the category to be added

addSubcategory

@Deprecated(since="ages",
            forRemoval=false)
public void addSubcategory(SessionContext ctx,
 Category category)

Deprecated.

since ages

Adds given category to subcategories of this category.

Parameters:

ctx - session context

category - the category to be added

addSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void addSubcategories(Collection<Category> categories)

Deprecated.

since ages

Adds given categories to subcategories of this category.

Parameters:

categories - Categories to be added

addSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void addSubcategories(SessionContext ctx,
 Collection<Category> categories)

Deprecated.

since ages

Adds given categories to subcategories of this category.

Parameters:

ctx - session context

categories - Categories to be added

removeSubcategory

@Deprecated(since="ages",
            forRemoval=false)
public void removeSubcategory(Category category)

Deprecated.

since ages

Removes given category from subcategories of this category.

Parameters:

category - the category to be removed from subcategories

removeSubcategory

@Deprecated(since="ages",
            forRemoval=false)
public void removeSubcategory(SessionContext ctx,
 Category category)

Deprecated.

since ages

Removes given category from subcategories of this category.

Parameters:

ctx - session context

category - the category to be removed from subcategories

removeSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void removeSubcategories(Collection<Category> categories)

Deprecated.

since ages

Removes given categories from subcategories of this category.

Parameters:

categories - Categories to be removed from subcategories

removeSubcategories

@Deprecated(since="ages",
            forRemoval=false)
public void removeSubcategories(SessionContext ctx,
 Collection<Category> categories)

Deprecated.

since ages

Removes given categories from subcategories of this category.

Parameters:

ctx - session context

categories - Categories to be removed from subcategories

getSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public Category getSupercategory()

Deprecated.

since ages

Gets one supercategory of this category or null if none is found. This method should be used only in cases without multiple supercategories - otherwise it cannot be predicted which supercategories is chosen!
To get all supercategories use GeneratedCategory.getSupercategories().

Returns:

the first found supercategory or null if this category has no supercategories

getSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public Category getSupercategory(SessionContext ctx)

Deprecated.

since ages

Gets one supercategory of this category or null if none is found. This method should be used only in cases without multiple supercategories - otherwise it cannot be predicted which supercategors is chosen!
To get all supercategories use GeneratedCategory.getSupercategories().

Parameters:

ctx - the session context

Returns:

the first found supercategory or null if this category has no supercategories

getSupercategoryCount

@Deprecated(since="ages",
            forRemoval=false)
public long getSupercategoryCount()

Deprecated.

since ages

Returns the amount of supercategories of this category. This method should be preferred over getSupercategories().size() since it does not actually load the subcategories.

getProductsCount

@Deprecated(since="ages",
            forRemoval=false)
public long getProductsCount()

Deprecated.

since ages - use ProductService.getProductsCountForCategory(de.hybris.platform.category.model.CategoryModel) instead.

Returns the amount of products of this category. This method should be preferred over getProducts().size() since it does not actually load the products.

Overrides:

getProductsCount in class GeneratedCategory

isEmpty

@Deprecated(since="ages",
            forRemoval=false)
public boolean isEmpty()

Deprecated.

since ages - use CategoryService.isEmpty(de.hybris.platform.category.model.CategoryModel) instead.

Returns true if neither products nor subcategories belong to this category. This method should be preferred over getProducts().size().isEmpty() && getSubcategories().isEmpty() since it does not actually load the products and categories.

containsProducts

@Deprecated(since="ages",
            forRemoval=false)
public boolean containsProducts()

Deprecated.

since ages - use ProductService.containsProductsForCategory(de.hybris.platform.category.model.CategoryModel) instead.

Opposing to isEmpty() this method tells whether or not this category or any of its subcategories contains a product.

Since:

2.10

getAllSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Category> getAllSupercategories()

Deprecated.

since ages - useCategoryModel.getAllSupercategories() instead.

Gets all supercategories of this category. This includes its own supercategories and all their supercategories.

Returns:

all categories above this category

Since:

1.3.1

getAllSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public Collection<Category> getAllSupercategories(SessionContext ctx)

Deprecated.

since ages - useCategoryModel.getAllSubcategories() instead.

Gets all supercategories of this category. This includes its own supercategories and all their supercategories.

Parameters:

ctx - session context

Returns:

all categories above this category

Since:

1.3.1

addSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public void addSupercategory(Category category)

Deprecated.

since ages

Adds given category to supercategories of this category.

Parameters:

category - the category to be added

addSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public void addSupercategory(SessionContext ctx,
 Category category)

Deprecated.

since ages

Adds given category to supercategories of this category.

Parameters:

ctx - session context

category - the category to be added

addSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void addSupercategories(Collection<Category> categories)

Deprecated.

since ages

Adds given categories to supercategories of this category.

Parameters:

categories - Categories to be added

addSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void addSupercategories(SessionContext ctx,
 Collection<Category> categories)

Deprecated.

since ages

Adds given categories to supercategories of this category.

Parameters:

ctx - session context

categories - Categories to be added

removeSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public void removeSupercategory(Category category)

Deprecated.

since ages

Removes given category from supercategories of this category.

Parameters:

category - the category to be removed from supercategories

removeSupercategory

@Deprecated(since="ages",
            forRemoval=false)
public void removeSupercategory(SessionContext ctx,
 Category category)

Deprecated.

since ages

Removes given category from supercategories of this category.

Parameters:

ctx - session context

category - the category to be removed from supercategories

removeSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void removeSupercategories(Collection<Category> categories)

Deprecated.

since ages

Removes given categories from supercategories of this category.

Parameters:

categories - Categories to be removed from supercategories

removeSupercategories

@Deprecated(since="ages",
            forRemoval=false)
public void removeSupercategories(SessionContext ctx,
 Collection<Category> categories)

Deprecated.

since ages

Removes given categories from supercategories of this category.

Parameters:

ctx - session context

categories - Categories to be removed from supercategories

addProduct

@Deprecated(since="ages",
            forRemoval=false)
public void addProduct(Product product)

Deprecated.

since ages

Adds given product to this category.

Parameters:

product - product to be added

addProduct

@Deprecated(since="ages",
            forRemoval=false)
public void addProduct(SessionContext ctx,
 Product product)

Deprecated.

since ages

Adds given product to this category.

Parameters:

ctx - session context

product - to be added

addProduct

@Deprecated(since="ages",
            forRemoval=false)
public void addProduct(Product product,
 int position,
 boolean shift)

Deprecated.

since ages

Adds given product to this category at given position.

Parameters:

product - product to be added

position - which will be set and used for sorting products

shift - whether succeeding products should shift their positions according to new product position or not

addProduct

@Deprecated(since="ages",
            forRemoval=false)
public void addProduct(SessionContext ctx,
 Product product,
 int position,
 boolean shift)

Deprecated.

since ages

Adds given product to this category at given position.

Parameters:

ctx - session context

product - to be added

position - which will be set and used for sorting products

shift - whether succeeding products should shift their positions according to new product position or not

addProducts

@Deprecated(since="ages",
            forRemoval=false)
public void addProducts(Collection<Product> products)

Deprecated.

since ages

Adds given products to this category at position 0. Existing products will be shifted.

Parameters:

products - to be added

addProducts

@Deprecated(since="ages",
            forRemoval=false)
public void addProducts(SessionContext ctx,
 Collection<Product> products)

Deprecated.

since ages

Adds given products to this category at position 0. Existing products will be shifted.

Parameters:

ctx - session context

products - to be added

removeProduct

@Deprecated(since="ages",
            forRemoval=false)
public void removeProduct(Product product)

Deprecated.

since ages

Removes given product from this category.

Parameters:

product - to be removed from this category

removeProduct

@Deprecated(since="ages",
            forRemoval=false)
public void removeProduct(SessionContext ctx,
 Product product)

Deprecated.

since ages

Removes given product from this category.

Parameters:

ctx - session context

product - to be removed from this category

removeProducts

@Deprecated(since="ages",
            forRemoval=false)
public void removeProducts(Collection<Product> products)

Deprecated.

since ages

Removes given products from this category.

Parameters:

products - to be removed from this category

removeProducts

@Deprecated(since="ages",
            forRemoval=false)
public void removeProducts(SessionContext ctx,
 Collection<Product> products)

Deprecated.

since ages

Removes given products from this category.

Parameters:

ctx - session context

products - to be removed from this category

getPath

@Deprecated(since="ages",
            forRemoval=false)
public List<Category> getPath()

Deprecated.

since ages - use CategoryService.getPathForCategory(de.hybris.platform.category.model.CategoryModel) instead.

Returns the path from root down to this category. This method should be used only in cases without multiple supercategories - otherwise it cannot be predicted which path is chosen!
To get all supercategories use GeneratedCategory.getSupercategories().

Returns:

the first found path for this category or null if this category has no supercategories

getPaths

@Deprecated(since="ages",
            forRemoval=false)
public Collection<List<Category>> getPaths()

Deprecated.

since ages - use CategoryService.getPathsForCategory(de.hybris.platform.category.model.CategoryModel) instead.

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

Returns:

all paths for this category or empty Collection if this category has no supercategories

checkRemovable

@Deprecated(since="ages",
            forRemoval=false)
protected void checkRemovable(SessionContext ctx)
                       throws ConsistencyCheckException

Deprecated.

since ages - covered byCategoryRemovalValidator.

Denies removal request if this category holds subcategories. You can disable this by setting the attribute DISABLE_SUBCATEGORY_REMOVALCHECK in the Sessioncontext to Boolean.TRUE

Overrides:

checkRemovable in class Item

Throws:

ConsistencyCheckException - to indicate that the item cannot be removed

isRoot

@Deprecated(since="ages",
            forRemoval=false)
public Boolean isRoot(SessionContext ctx)

Deprecated.

since ages - use CategoryService.isRoot(de.hybris.platform.category.model.CategoryModel) instead.

Returns:

true of this is a root category.

isRoot

@Deprecated(since="ages",
            forRemoval=false)
public Boolean isRoot()

Deprecated.

since ages - use CategoryService.isRoot(de.hybris.platform.category.model.CategoryModel) instead.

Returns:

true of this is a root category

isRootAsPrimitive

public boolean isRootAsPrimitive(SessionContext ctx)

Returns:

true of this is a root category

isRootAsPrimitive

public boolean isRootAsPrimitive()

Returns:

true of this is a root category

setAllowedPrincipals

@Deprecated(since="ages",
            forRemoval=false)
public void setAllowedPrincipals(SessionContext ctx,
 List<Principal> newOnes)

Deprecated.

since ages - use CategoryService.setAllowedPrincipalsForCategory(de.hybris.platform.category.model.CategoryModel, List) instead.

Copies changed visibilities down to subcategories and assures that added principals are allowed to all super categories too. If in the SessionContext DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY is set to true the given principal list is only set to the given category.

Overrides:

setAllowedPrincipals in class GeneratedCategory

Parameters:

ctx - the SessionContext

newOnes - the list with the new allowed principals of this category

See Also:

• setAllowedPrincipals(de.hybris.platform.jalo.SessionContext, java.util.List)

setAllowedPrincipalsOnlyForPassedCategory

public void setAllowedPrincipalsOnlyForPassedCategory(SessionContext ctx,
 List<Principal> value)

isSetAllowedPrincipalsRecursivelyDisabled

@Deprecated(since="ages",
            forRemoval=false)
protected boolean isSetAllowedPrincipalsRecursivelyDisabled(SessionContext ctx)

Deprecated.

since ages - covered byCategoryPrincipalStrategy.

If this method returns true the method setAllowedPrincipals(SessionContext, List) will only set the given list of principals to the given category only.

Parameters:

ctx - SessionContext

Returns:

true if in the given Sessioncontext the Attribute DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY exists and is set to true. false otherwise.

pullUpAllowedPrincipalInternals

@Deprecated(since="ages",
            forRemoval=false)
protected void pullUpAllowedPrincipalInternals(SessionContext ctx,
 Category superCat,
 List<Principal> newOnes)

Deprecated.

since ages - covered byCategoryPrincipalStrategy.

Just adds principals which are not yet included in allowed principal set. Missing principals are not removed here!

Parameters:

ctx -

newOnes - the principal set to pull up

isSubcategoryRemovalCheckDisabled

@Deprecated(since="ages",
            forRemoval=false)
protected boolean isSubcategoryRemovalCheckDisabled(SessionContext ctx)

Deprecated.

since ages - covered byCategoryRemovalValidator.

Parameters:

ctx - the session context

Returns:

true if in the given SessionContext the attribute DISABLE_SUBCATEGORY_REMOVALCHECK exists AND the value of this attribute is true