Package com.broadleafcommerce.rest.api.wrapper

Class SearchFacetWrapper

java.lang.Object

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

com.broadleafcommerce.rest.api.wrapper.SearchFacetWrapper

All Implemented Interfaces:

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

public class SearchFacetWrapper
extends org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper
implements org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.search.domain.SearchFacetDTO>

This wrapper provides information about the search facets available for use with a search. Search facets are typically returned from a catalog search as part of the result. You can use facets to narrow a search.

Author:

Kelly Tisdell

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	active
protected Boolean	canMultiselect
protected String	fieldName
protected String	label	Label for the field.
protected List<SearchFacetValueWrapper>	values

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

context

Constructor Summary

Constructors

Constructor	Description
SearchFacetWrapper()

Method Summary

Modifier and Type	Method	Description
Boolean	getActive()
String	getFieldName()
String	getLabel()
List<SearchFacetValueWrapper>	getValues()
void	setActive(Boolean active)
void	setFieldName(String fieldName)
void	setLabel(String label)
void	setValues(List<SearchFacetValueWrapper> values)
void	wrapDetails(org.broadleafcommerce.core.search.domain.SearchFacetDTO model, jakarta.servlet.http.HttpServletRequest request)
void	wrapSummary(org.broadleafcommerce.core.search.domain.SearchFacetDTO model, jakarta.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 Details

fieldName

protected String fieldName

label

protected String label

Label for the field. (e.g. might be Manufacturer, Price, Color)

active

protected Boolean active

canMultiselect

protected Boolean canMultiselect

values

protected List<SearchFacetValueWrapper> values

Constructor Details

SearchFacetWrapper

public SearchFacetWrapper()

Method Details

wrapDetails

public void wrapDetails(org.broadleafcommerce.core.search.domain.SearchFacetDTO model,
 jakarta.servlet.http.HttpServletRequest request)

Specified by:

wrapDetails in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.search.domain.SearchFacetDTO>

wrapSummary

public void wrapSummary(org.broadleafcommerce.core.search.domain.SearchFacetDTO model,
 jakarta.servlet.http.HttpServletRequest request)

Specified by:

wrapSummary in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.core.search.domain.SearchFacetDTO>

getFieldName

public String getFieldName()

Returns:

the fieldName

setFieldName

public void setFieldName(String fieldName)

Parameters:

fieldName - the fieldName to set

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getActive

public Boolean getActive()

Returns:

the active

setActive

public void setActive(Boolean active)

Parameters:

active - the active to set

getValues

public List<SearchFacetValueWrapper> getValues()

Returns:

the values

setValues

public void setValues(List<SearchFacetValueWrapper> values)

Parameters:

values - the values to set