Package com.broadleafcommerce.catalogbrowse.domain

Class Category

java.lang.Object

com.broadleafcommerce.catalogbrowse.domain.Category

All Implemented Interfaces:

Serializable

public class Category
extends Object
implements Serializable

A structure containing all the info necessary for a category details page or section shown in a commerce-facing app (as opposed to a PIM UI).

Author:

Nathan Moore (nathandmoore)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Category()

Method Summary

Modifier and Type	Method	Description
void	addAttribute(String name, Object value)	Takes in any additional attributes passed in the request not matching any defined properties.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttribute()	Return any additional attributes passed in the request not matching any defined properties.
Map<String,Object>	getAttributes()	Map holding any additional attributes passed in the request not matching any defined properties.
String	getId()	The context ID of the category.
Locale	getProductMembershipLocale()	The locale used to check if a related product is a member of this category.
String	getProductMembershipRule()	The rule string used to check if a related product is a member of this category.
String	getProductMembershipType()	Determines how this category defines membership of its products.
SimplePage<Product>	getProducts()	A page of Products belonging to the category.
Map<String,List<PromotionalCategoryProduct>>	getPromotionalProducts()	A map of promotional products belonging to the category.
SearchResponse<Product>	getSearchResponse()	If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of products.
int	hashCode()
void	setAttributes(Map<String,Object> attributes)	Map holding any additional attributes passed in the request not matching any defined properties.
void	setId(String id)	The context ID of the category.
void	setProductMembershipLocale(Locale productMembershipLocale)	The locale used to check if a related product is a member of this category.
void	setProductMembershipRule(String productMembershipRule)	The rule string used to check if a related product is a member of this category.
void	setProductMembershipType(String productMembershipType)	Determines how this category defines membership of its products.
void	setProducts(SimplePage<Product> products)	A page of Products belonging to the category.
void	setPromotionalProducts(Map<String,List<PromotionalCategoryProduct>> promotionalProducts)	A map of promotional products belonging to the category.
void	setSearchResponse(SearchResponse<Product> searchResponse)	If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of products.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Category

public Category()

Method Details

addAttribute

public void addAttribute(String name,
 Object value)

Takes in any additional attributes passed in the request not matching any defined properties.

Parameters:

name - Name of the additional attribute

value - Value of the additional attribute

getAttribute

public Map<String,Object> getAttribute()

Return any additional attributes passed in the request not matching any defined properties.

Returns:

any additional attributes passed in the request not matching any defined properties.

getId

public String getId()

The context ID of the category.

Returns:

the context ID of the category

getProducts

public SimplePage<Product> getProducts()

A page of Products belonging to the category. To configure the page pass paging params to the endpoint.

Returns:

A page of Products belonging to the category.

getPromotionalProducts

public Map<String,List<PromotionalCategoryProduct>> getPromotionalProducts()

A map of promotional products belonging to the category.

Returns:

A map of promotional products belonging to the category.

getProductMembershipType

public String getProductMembershipType()

Determines how this category defines membership of its products. Valid types are found at CategoryProductMembershipType.

Returns:

the product membership type of the category

See Also:

• CategoryProductMembershipType
• PromotionalCategoryProduct
• getProductMembershipRule()

getProductMembershipRule

public String getProductMembershipRule()

The rule string used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED.

Returns:

the expression used to evaluate a related product's membership in this category

See Also:

• CategoryProductMembershipType

getProductMembershipLocale

public Locale getProductMembershipLocale()

The locale used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED. By default, this is set as the catalog locale.

Returns:

the locale used to evaluate a related product's membership in this category

See Also:

• CategoryProductMembershipType

getSearchResponse

public SearchResponse<Product> getSearchResponse()

If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of products.

getAttributes

public Map<String,Object> getAttributes()

Map holding any additional attributes passed in the request not matching any defined properties.

setId

public void setId(String id)

The context ID of the category.

Parameters:

id - the context ID of the category

setProducts

public void setProducts(SimplePage<Product> products)

A page of Products belonging to the category. To configure the page pass paging params to the endpoint.

Parameters:

products - A page of Products belonging to the category.

setPromotionalProducts

public void setPromotionalProducts(Map<String,List<PromotionalCategoryProduct>> promotionalProducts)

A map of promotional products belonging to the category.

Parameters:

products - A map of promotional products belonging to the category.

setProductMembershipType

public void setProductMembershipType(String productMembershipType)

Determines how this category defines membership of its products. Valid types are found at CategoryProductMembershipType.

Parameters:

productMembershipType - the product membership type of the category

See Also:

• CategoryProductMembershipType
• PromotionalCategoryProduct
• getProductMembershipRule()

setProductMembershipRule

public void setProductMembershipRule(String productMembershipRule)

The rule string used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED.

Parameters:

productMembershipRule - an expression based off of Product criteria

See Also:

• CategoryProductMembershipType

setProductMembershipLocale

public void setProductMembershipLocale(Locale productMembershipLocale)

The locale used to check if a related product is a member of this category. Only applies when this category's product membership type is CategoryProductMembershipType.RULE_BASED. By default, this is set as the catalog locale.

Parameters:

productMembershipLocale - the locale to evaluate the membership rule

See Also:

• CategoryProductMembershipType

setSearchResponse

public void setSearchResponse(SearchResponse<Product> searchResponse)

If CategoryDetailsRequest.isHydrateCategoryProductsFromSearch() or BrowseDetailsRequest.isHydrateCategoryProductsFromSearch() is true, then this will be populated instead of products.

setAttributes

public void setAttributes(Map<String,Object> attributes)

Map holding any additional attributes passed in the request not matching any defined properties.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object