org.broadleafcommerce.core.web.api.wrapper

Class CategoryWrapper

java.lang.Object

org.broadleafcommerce.core.web.api.wrapper.BaseWrapper

org.broadleafcommerce.core.web.api.wrapper.CategoryWrapper

All Implemented Interfaces:

APIWrapper<Category>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class CategoryWrapper
extends BaseWrapper
implements APIWrapper<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;

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	active
protected java.util.Date	activeEndDate
protected java.util.Date	activeStartDate
protected java.util.List<CategoryAttributeWrapper>	categoryAttributes
protected java.lang.String	description
protected java.lang.Long	id
protected java.lang.String	name
protected java.util.List<ProductWrapper>	products
protected java.util.List<CategoryWrapper>	subcategories
protected java.lang.String	url
protected java.lang.String	urlKey

Fields inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper

context

Constructor Summary

Constructors

Constructor and Description
CategoryWrapper()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<CategoryWrapper>	buildSubcategoryTree(java.util.List<CategoryWrapper> wrappers, Category root, javax.servlet.http.HttpServletRequest request)
void	wrapDetails(Category category, javax.servlet.http.HttpServletRequest request)
void	wrapSummary(Category category, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.broadleafcommerce.core.web.api.wrapper.BaseWrapper

setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.Long id

name

protected java.lang.String name

description

protected java.lang.String description

active

protected java.lang.Boolean active

url

protected java.lang.String url

urlKey

protected java.lang.String urlKey

activeStartDate

protected java.util.Date activeStartDate

activeEndDate

protected java.util.Date activeEndDate

subcategories

protected java.util.List<CategoryWrapper> subcategories

products

protected java.util.List<ProductWrapper> products

categoryAttributes

protected java.util.List<CategoryAttributeWrapper> categoryAttributes

Constructor Detail

CategoryWrapper

public CategoryWrapper()

Method Detail

wrapDetails

public void wrapDetails(Category category,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapDetails in interface APIWrapper<Category>

wrapSummary

public void wrapSummary(Category category,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapSummary in interface APIWrapper<Category>

buildSubcategoryTree

protected java.util.List<CategoryWrapper> buildSubcategoryTree(java.util.List<CategoryWrapper> wrappers,
                                                               Category root,
                                                               javax.servlet.http.HttpServletRequest request)