com.broadleafcommerce.rest.api.wrapper

Class CategoryWrapper

java.lang.Object

org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

com.broadleafcommerce.rest.api.wrapper.CategoryWrapper

All Implemented Interfaces:

Serializable, org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.catalog.domain.Category>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class CategoryWrapper
extends org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper
implements org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.catalog.domain.Category>

This is a JAXB wrapper for a Broadleaf Category. There may be several reasons to extend this class. First, you may want to extend Broadleaf's CategroryImpl and expose those extensions via a RESTful service. You may also want to suppress properties that are being serialized. To expose new properties, or suppress properties that have been exposed, do the following:

1. Extend this class
2. Override the wrap method.
3. Within the wrap method, either override all properties that you want to set, or call super.wrap(Category)
4. Set additional property values that you have added.
5. Set super properties to null if you do not want them serialized. (e.g. super.name = null;

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	active
protected Date	activeEndDate
protected Date	activeStartDate
protected Character	archived
protected List<CategoryAttributeWrapper>	categoryAttributes
protected String	description
protected Long	id
protected String	longDescription
protected String	name
protected List<ProductWrapper>	products
protected List<ProductWrapper>	relatedProducts
protected List<CategoryWrapper>	subcategories
protected String	url
protected String	urlKey

Fields inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

context

Constructor Summary

Constructors

Constructor and Description
CategoryWrapper()

Method Summary

Modifier and Type	Method and Description
protected List<CategoryWrapper>	buildSubcategoryTree(List<CategoryWrapper> wrappers, org.broadleafcommerce.core.catalog.domain.Category root, javax.servlet.http.HttpServletRequest request)
Boolean	getActive()
Date	getActiveEndDate()
Date	getActiveStartDate()
Character	getArchived()
List<CategoryAttributeWrapper>	getCategoryAttributes()
String	getDescription()
Long	getId()
String	getLongDescription()
String	getName()
List<ProductWrapper>	getProducts()
protected org.broadleafcommerce.core.search.service.SearchService	getSearchService()
List<CategoryWrapper>	getSubcategories()
String	getUrl()
String	getUrlKey()
void	setActive(Boolean active)
void	setActiveEndDate(Date activeEndDate)
void	setActiveStartDate(Date activeStartDate)
void	setArchived(Character archived)
void	setCategoryAttributes(List<CategoryAttributeWrapper> categoryAttributes)
void	setDescription(String description)
void	setId(Long id)
void	setLongDescription(String longDescription)
void	setName(String name)
void	setProducts(List<ProductWrapper> products)
void	setSubcategories(List<CategoryWrapper> subcategories)
void	setUrl(String url)
void	setUrlKey(String urlKey)
void	wrapDetails(org.broadleafcommerce.core.catalog.domain.Category category, javax.servlet.http.HttpServletRequest request)
void	wrapSummary(org.broadleafcommerce.core.catalog.domain.Category category, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

createElementWrappers, setApplicationContext, transferAdditionalFieldsFromWrapper

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

name

protected String name

description

protected String description

longDescription

protected String longDescription

active

protected Boolean active

url

protected String url

urlKey

protected String urlKey

activeStartDate

protected Date activeStartDate

activeEndDate

protected Date activeEndDate

subcategories

protected List<CategoryWrapper> subcategories

products

protected List<ProductWrapper> products

relatedProducts

protected List<ProductWrapper> relatedProducts

categoryAttributes

protected List<CategoryAttributeWrapper> categoryAttributes

archived

protected Character archived

Constructor Detail

CategoryWrapper

public CategoryWrapper()

Method Detail

wrapDetails

public void wrapDetails(org.broadleafcommerce.core.catalog.domain.Category category,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapDetails in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.catalog.domain.Category>

wrapSummary

public void wrapSummary(org.broadleafcommerce.core.catalog.domain.Category category,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapSummary in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.catalog.domain.Category>

buildSubcategoryTree

protected List<CategoryWrapper> buildSubcategoryTree(List<CategoryWrapper> wrappers,
                                                     org.broadleafcommerce.core.catalog.domain.Category root,
                                                     javax.servlet.http.HttpServletRequest request)

getSearchService

protected org.broadleafcommerce.core.search.service.SearchService getSearchService()

getId

public Long getId()

Returns:

the id

setId

public void setId(Long id)

Parameters:

id - the id to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getLongDescription

public String getLongDescription()

Returns:

the long description

setLongDescription

public void setLongDescription(String longDescription)

Parameters:

longDescription - the long description to set

getActive

public Boolean getActive()

Returns:

the active

setActive

public void setActive(Boolean active)

Parameters:

active - the active to set

getUrl

public String getUrl()

Returns:

the url

setUrl

public void setUrl(String url)

Parameters:

url - the url to set

getUrlKey

public String getUrlKey()

Returns:

the urlKey

setUrlKey

public void setUrlKey(String urlKey)

Parameters:

urlKey - the urlKey to set

getActiveStartDate

public Date getActiveStartDate()

Returns:

the activeStartDate

setActiveStartDate

public void setActiveStartDate(Date activeStartDate)

Parameters:

activeStartDate - the activeStartDate to set

getActiveEndDate

public Date getActiveEndDate()

Returns:

the activeEndDate

setActiveEndDate

public void setActiveEndDate(Date activeEndDate)

Parameters:

activeEndDate - the activeEndDate to set

getSubcategories

public List<CategoryWrapper> getSubcategories()

Returns:

the subcategories

setSubcategories

public void setSubcategories(List<CategoryWrapper> subcategories)

Parameters:

subcategories - the subcategories to set

getProducts

public List<ProductWrapper> getProducts()

Returns:

the products

setProducts

public void setProducts(List<ProductWrapper> products)

Parameters:

products - the products to set

getCategoryAttributes

public List<CategoryAttributeWrapper> getCategoryAttributes()

Returns:

the categoryAttributes

setCategoryAttributes

public void setCategoryAttributes(List<CategoryAttributeWrapper> categoryAttributes)

Parameters:

categoryAttributes - the categoryAttributes to set

getArchived

public Character getArchived()

setArchived

public void setArchived(Character archived)