public class SearchParams
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.util.List<AttributeFilter> |
attributeFilters |
private java.util.Currency |
currency |
private int |
currentPage |
static int |
DEFAULT_RESULTS_PER_PAGE |
private FacetMode |
facetMode |
private java.util.Locale |
lang |
private static int |
MIN_PAGE |
private java.lang.String |
query |
private int |
resultsPerPage |
private SortBy |
sortBy |
private java.lang.String |
taxArea |
Constructor and Description |
---|
SearchParams() |
Modifier and Type | Method and Description |
---|---|
java.util.List<AttributeFilter> |
getAttributeFilters()
Each entry allows to filter for a specific attribute-value
or -range of a product-attribute.
|
java.util.Currency |
getCurrency() |
java.lang.String |
getCurrencyCode()
The price calculation is based on the currency.
|
int |
getCurrentPage()
The current page of the search-results page.
|
FacetMode |
getFacetMode()
Specifies whether the response includes no facets,
only standard facets or standard and custom facets.
|
java.lang.String |
getLang()
A two-digit code used for the
localisation of the search-results.
|
java.util.Locale |
getLangAsLocale() |
java.lang.String |
getQuery()
If the search-query is empty or null, a wildcard search
is executed which returns all products of a shop.
|
int |
getResultsPerPage()
The number of search-results
which are displayed on a single page.
|
SortBy |
getSortBy()
Determines the sorting of the search-results.
|
java.lang.String |
getTaxArea()
If the alias of the tax-area is not set, the price-calculation
is based on net-prices.
|
void |
setAttributeFilters(java.util.List<AttributeFilter> attributeFilters) |
void |
setCurrency(java.util.Currency currency) |
void |
setCurrencyCode(java.lang.String currencyCode) |
void |
setCurrentPage(int currentPage) |
void |
setFacetMode(FacetMode facetMode) |
void |
setLang(java.util.Locale lang) |
void |
setQuery(java.lang.String query) |
void |
setResultsPerPage(int resultsPerPage) |
void |
setSortBy(SortBy sortBy) |
void |
setTaxArea(java.lang.String taxArea) |
java.lang.String |
toString() |
private static final int MIN_PAGE
public static final int DEFAULT_RESULTS_PER_PAGE
private java.lang.String query
private java.util.Locale lang
private int resultsPerPage
private int currentPage
private java.util.Currency currency
private SortBy sortBy
private java.lang.String taxArea
private java.util.List<AttributeFilter> attributeFilters
private FacetMode facetMode
public java.lang.String getQuery()
public void setQuery(java.lang.String query)
public java.lang.String getLang()
public void setLang(java.util.Locale lang)
public java.util.Locale getLangAsLocale()
public int getResultsPerPage()
public void setResultsPerPage(int resultsPerPage)
public int getCurrentPage()
public void setCurrentPage(int currentPage)
public void setSortBy(SortBy sortBy)
public SortBy getSortBy()
public java.lang.String getCurrencyCode()
public void setCurrencyCode(java.lang.String currencyCode)
public java.util.Currency getCurrency()
public void setCurrency(java.util.Currency currency)
public java.util.List<AttributeFilter> getAttributeFilters()
public void setAttributeFilters(java.util.List<AttributeFilter> attributeFilters)
public java.lang.String getTaxArea()
public void setTaxArea(java.lang.String taxArea)
public FacetMode getFacetMode()
public void setFacetMode(FacetMode facetMode)
public java.lang.String toString()
toString
in class java.lang.Object