com.elasticpath.domain.catalogview
Interface FilterOption

All Superinterfaces:
EpDomain, java.io.Serializable, Transient
All Known Subinterfaces:
BrowsingFilterOption
All Known Implementing Classes:
BrowsingFilterOptionImpl, FilterOptionImpl

public interface FilterOption
extends Transient

Represents a filter option in a CatalogViewResult.


Method Summary
 java.lang.String getDisplayName(java.util.Locale locale)
          Returns the display name of the given locale.
 int getHitsNumber()
          Returns the number of hits in the filter option.
 java.lang.String getQueryString()
          Returns the query string.
 void setCatalogViewRequest(CatalogViewRequest catalogViewRequest)
          Sets the catalog view request corresponding to this filter option.
 void setFilter(Filter filter)
          Sets the search filter.
 void setHitsNumber(int hitsNumber)
          Sets the number of hits in under the filter option.
 
Methods inherited from interface com.elasticpath.domain.EpDomain
getElasticPath, setElasticPath
 

Method Detail

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
Returns the display name of the given locale.

Parameters:
locale - the locale
Returns:
the display name of the given locale.

getHitsNumber

int getHitsNumber()
Returns the number of hits in the filter option.

Returns:
the number of hits in the filter option.

getQueryString

java.lang.String getQueryString()
Returns the query string.

Returns:
the query string.

setCatalogViewRequest

void setCatalogViewRequest(CatalogViewRequest catalogViewRequest)
Sets the catalog view request corresponding to this filter option.

Parameters:
catalogViewRequest - the catalog view request

setFilter

void setFilter(Filter filter)
Sets the search filter.

Parameters:
filter - the search filter.

setHitsNumber

void setHitsNumber(int hitsNumber)
Sets the number of hits in under the filter option.

Parameters:
hitsNumber - the hits number to set