org.broadleafcommerce.catalog.domain
Interface Category

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CategoryImpl

public interface Category
extends java.io.Serializable

Implementations of this interface are used to hold data about a Category. A category is a group of products.

You should implement this class if you want to make significant changes to how the Category is persisted. If you just want to add additional fields then you should extend CategoryImpl.

Author:

btaylor

See Also:

CategoryImpl}

Method Summary

java.util.Date	getActiveEndDate() Gets the active end date.
java.util.Date	getActiveStartDate() Gets the active start date.
java.util.List<Category>	getAllChildCategories() Gets the child categories.
java.util.List<Category>	getAllParentCategories()
java.lang.String	getCategoryImage(java.lang.String imageKey) Gets the category image.
java.util.Map<java.lang.String,java.lang.String>	getCategoryImages() Gets the category images.
java.util.Map<java.lang.String,Media>	getCategoryMedia() Gets the category media map
java.util.List<Category>	getChildCategories() Gets the child categories.
java.util.Map<java.lang.String,java.util.List<Category>>	getChildCategoryURLMap() Gets the child category url map.
Category	getDefaultParentCategory() Gets the default parent category.
java.lang.String	getDescription() Gets the description.
java.lang.String	getDisplayTemplate() Gets the display template.
java.util.List<FeaturedProduct>	getFeaturedProducts() Gets the featured products.
java.lang.String	getGeneratedUrl() Gets the generated url.
java.lang.Long	getId() Gets the id.
java.lang.String	getLongDescription() Gets the long description.
java.lang.String	getName() Gets the name.
java.lang.String	getUrl() Gets the url.
java.lang.String	getUrlKey() Gets the url key.
boolean	hasAllChildCategories() Checks for child categories.
boolean	hasChildCategories() Checks for child categories.
boolean	isActive() Checks if is active.
void	setActiveEndDate(java.util.Date activeEndDate) Sets the active end date.
void	setActiveStartDate(java.util.Date activeStartDate) Sets the active start date.
void	setAllChildCategories(java.util.List<Category> childCategories) Sets the all child categories.
void	setAllParentCategories(java.util.List<Category> allParentCategories)
void	setCategoryImages(java.util.Map<java.lang.String,java.lang.String> categoryImages) Sets the category images.
void	setCategoryMedia(java.util.Map<java.lang.String,Media> categoryMedia) Sets the category images.
void	setChildCategories(java.util.List<Category> childCategories) Sets the all child categories.
void	setChildCategoryURLMap(java.util.Map<java.lang.String,java.util.List<Category>> cachedChildCategoryUrlMap)
void	setDefaultParentCategory(Category defaultParentCategory) Sets the default parent category.
void	setDescription(java.lang.String description) Sets the description.
void	setDisplayTemplate(java.lang.String displayTemplate) Sets the display template.
void	setFeaturedProducts(java.util.List<FeaturedProduct> featuredProducts) Sets the featured products.
void	setId(java.lang.Long id) Sets the id.
void	setLongDescription(java.lang.String longDescription) Sets the long description.
void	setName(java.lang.String name) Sets the name.
void	setUrl(java.lang.String url) Sets the url.
void	setUrlKey(java.lang.String urlKey) Sets the url key.

Method Detail

getId

java.lang.Long getId()

Gets the id.

Returns:

the id

setId

void setId(java.lang.Long id)

Sets the id.

Parameters:

id - the new id

getName

java.lang.String getName()

Gets the name.

Returns:

the name

setName

void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

getDefaultParentCategory

Category getDefaultParentCategory()

Gets the default parent category.

Returns:

the default parent category

setDefaultParentCategory

void setDefaultParentCategory(Category defaultParentCategory)

Sets the default parent category.

Parameters:

defaultParentCategory - the new default parent category

getAllParentCategories

java.util.List<Category> getAllParentCategories()

setAllParentCategories

void setAllParentCategories(java.util.List<Category> allParentCategories)

getUrl

java.lang.String getUrl()

Gets the url.

Returns:

the url

setUrl

void setUrl(java.lang.String url)

Sets the url.

Parameters:

url - the new url

getUrlKey

java.lang.String getUrlKey()

Gets the url key.

Returns:

the url key

getGeneratedUrl

java.lang.String getGeneratedUrl()

Gets the generated url.

Returns:

the generated url

setUrlKey

void setUrlKey(java.lang.String urlKey)

Sets the url key.

Parameters:

urlKey - the new url key

getDescription

java.lang.String getDescription()

Gets the description.

Returns:

the description

setDescription

void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the new description

getActiveStartDate

java.util.Date getActiveStartDate()

Gets the active start date.

Returns:

the active start date

setActiveStartDate

void setActiveStartDate(java.util.Date activeStartDate)

Sets the active start date.

Parameters:

activeStartDate - the new active start date

getActiveEndDate

java.util.Date getActiveEndDate()

Gets the active end date.

Returns:

the active end date

setActiveEndDate

void setActiveEndDate(java.util.Date activeEndDate)

Sets the active end date.

Parameters:

activeEndDate - the new active end date

isActive

boolean isActive()

Checks if is active.

Returns:

true, if is active

getDisplayTemplate

java.lang.String getDisplayTemplate()

Gets the display template.

Returns:

the display template

setDisplayTemplate

void setDisplayTemplate(java.lang.String displayTemplate)

Sets the display template.

Parameters:

displayTemplate - the new display template

getChildCategoryURLMap

java.util.Map<java.lang.String,java.util.List<Category>> getChildCategoryURLMap()

Gets the child category url map.

Returns:

the child category url map

setChildCategoryURLMap

void setChildCategoryURLMap(java.util.Map<java.lang.String,java.util.List<Category>> cachedChildCategoryUrlMap)

getAllChildCategories

java.util.List<Category> getAllChildCategories()

Gets the child categories.

Returns:

the child categories

hasAllChildCategories

boolean hasAllChildCategories()

Checks for child categories.

Returns:

true, if successful

setAllChildCategories

void setAllChildCategories(java.util.List<Category> childCategories)

Sets the all child categories.

Parameters:

allChildCategories - the new all child categories

getChildCategories

java.util.List<Category> getChildCategories()

Gets the child categories.

Returns:

the child categories

hasChildCategories

boolean hasChildCategories()

Checks for child categories.

Returns:

true, if successful

setChildCategories

void setChildCategories(java.util.List<Category> childCategories)

Sets the all child categories.

Parameters:

allChildCategories - the new all child categories

getCategoryImages

java.util.Map<java.lang.String,java.lang.String> getCategoryImages()

Gets the category images.

Returns:

the category images

getCategoryImage

java.lang.String getCategoryImage(java.lang.String imageKey)

Gets the category image.

Parameters:

imageKey - the image key

Returns:

the category image

setCategoryImages

void setCategoryImages(java.util.Map<java.lang.String,java.lang.String> categoryImages)

Sets the category images.

Parameters:

categoryImages - the category images

getCategoryMedia

java.util.Map<java.lang.String,Media> getCategoryMedia()

Gets the category media map

Returns:

the category Media

setCategoryMedia

void setCategoryMedia(java.util.Map<java.lang.String,Media> categoryMedia)

Sets the category images.

Parameters:

categoryMedia - the category media

getLongDescription

java.lang.String getLongDescription()

Gets the long description.

Returns:

the long description

setLongDescription

void setLongDescription(java.lang.String longDescription)

Sets the long description.

Parameters:

longDescription - the new long description

getFeaturedProducts

java.util.List<FeaturedProduct> getFeaturedProducts()

Gets the featured products.

Returns:

the featured products

setFeaturedProducts

void setFeaturedProducts(java.util.List<FeaturedProduct> featuredProducts)

Sets the featured products.

Parameters:

featuredProducts - the featured products