ProductSearch (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.ProductSearch

All Implemented Interfaces:: ProductSearchIf

public class ProductSearch
extends java.lang.Object
implements ProductSearchIf

ProductSearch object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NOT_SET` NOT_SET = -1
`static int`	`SEARCH_ALL` SEARCH_ALL = -100
`static int`	`SEARCH_IN_PRODUCT_DESCRIPTION` SEARCH_IN_PRODUCT_DESCRIPTION

Constructor Summary

Constructors
Constructor and Description

ProductSearch()
Constructor

Constructors
Constructor and Description
`ProductSearch()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCategoryId()` Used as a constraint when not set to ProductSearch.SEARCH_ALL and when categoryIds is null or empty.
`int[]`	`getCategoryIds()` When not null and containing data, the category ids in this array are used to provide constraints and the categoryId attribute is ignored.
`java.util.Calendar`	`getDateAddedFrom()`
`java.util.Calendar`	`getDateAddedTo()`
`java.util.Calendar`	`getDateAvailableFrom()` The date available used for the search is that for the main product and not for the product variations.
`java.util.Calendar`	`getDateAvailableTo()` The date available used for the search is that for the main product and not for the product variations.
`java.util.Calendar`	`getEndDateFrom()` Used for Bookable Products
`java.util.Calendar`	`getEndDateTo()` Used for Bookable Products
`java.util.Calendar`	`getExpiryDateFrom()` Used to search for products based on the expiry date
`java.util.Calendar`	`getExpiryDateTo()` Used to search for products based on the expiry date
`int`	`getManufacturerId()` Used as a constraint when not set to ProductSearch.SEARCH_ALL and when manufacturerIds is null or empty.
`int[]`	`getManufacturerIds()` When not null and containing data, the manufacturer ids in this array are used to provide constraints and the manufacturerId attribute is ignored.
`java.lang.Integer`	`getOrderedEqual()` Returns all products that have been ordered a number of times equal to the value.
`java.lang.Integer`	`getOrderedGreaterThan()` Returns all products that have been ordered more times than the value.
`java.lang.Integer`	`getOrderedLessThan()` Returns all products that have been ordered less times than the value.
`java.util.Calendar`	`getOverlapEndDate()` When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object.
`java.util.Calendar`	`getOverlapStartDate()` When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object.
`PriceFacetOptionsIf`	`getPriceFacetOptions()` Used to configure price facets.
`java.math.BigDecimal`	`getPriceFrom()`
`java.math.BigDecimal`	`getPriceTo()`
`java.lang.String`	`getPriceTypeRequired()`
`int`	`getProductId()`
`int`	`getProductType()`
`java.lang.Integer`	`getQuantityEqual()` Returns all products with a quantity equal to the value.
`java.lang.Integer`	`getQuantityGreaterThan()` Returns all products with a quantity greater than the value.
`java.lang.Integer`	`getQuantityLessThan()` Returns all products with a quantity less than the value.
`java.math.BigDecimal`	`getRatingEqual()` Returns all products with a rating equal to the value.
`java.math.BigDecimal`	`getRatingGreaterThan()` Returns all products with a rating greater than the value.
`java.math.BigDecimal`	`getRatingLessThan()` Returns all products with a rating less than the value.
`java.lang.Boolean`	`getReturnExtras()`
`static int`	`getSEARCH_ALL()`
`java.lang.String`	`getSearchText()`
`int`	`getSearchTextRule()` The rule for the search.
`SnippetOptionsIf`	`getSnippetOptions()` Used to configure fragments of text returned by the search engine that surround the keywords.
`java.util.Calendar`	`getStartDateFrom()` Used for Bookable Products
`java.util.Calendar`	`getStartDateTo()` Used for Bookable Products
`java.lang.String[]`	`getStoresToSearch()` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`TagGroupIf[]`	`getTagGroups()` For a single tag group, all products are returned that have any one of the tags in the group (i.e.
`java.lang.Integer`	`getTcposArticleId()`
`java.lang.Integer`	`getTcposShopId()` Used to check wheter this product is Blocked for this shopID
`java.lang.String`	`getTcposTypeId()`
`java.util.Calendar`	`getTcposValidityDate()`
`int`	`getWhereToSearch()` When set to 0, the text search is done only on the product name.
`boolean`	`isFillDescription()` Fills the product description attribute with the description in the chosen language.
`boolean`	`isForceUseSolr()` When set to true, Solr is used even though KonaKart may not have used Solr.
`boolean`	`isReturnCategoryFacets()` When set, the result of a product search using Solr contains the category facets including the number of products per category.
`boolean`	`isReturnCustomFacets()` When set, the result of a product search using Solr contains the custom facets.
`boolean`	`isReturnManufacturerFacets()` When set, the result of a product search using Solr contains the manufacturer facets including the number of products per manufacturer.
`boolean`	`isReturnSearchScore()` When set and Solr is enabled, the search results include the Solr score
`boolean`	`isSearchAllStores()` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`boolean`	`isSearchInCustomd5()` Determines whether products are searched in customd5 attributes
`boolean`	`isSearchInSubCats()` Determines whether products are searched for in child categories when there are category constraints.
`boolean`	`isTokenizeSolrInput()` Determines whether to tokenize Solr search string on whitespace
`void`	`setCategoryId(int categoryId)` Used as a constraint when not set to ProductSearch.SEARCH_ALL and when categoryIds is null or empty.
`void`	`setCategoryIds(int[] categoryIds)` When not null and containing data, the category ids in this array are used to provide constraints and the categoryId attribute is ignored.
`void`	`setDateAddedFrom(java.util.Calendar dateAddedFrom)`
`void`	`setDateAddedTo(java.util.Calendar dateAddedTo)`
`void`	`setDateAvailableFrom(java.util.Calendar dateAvailableFrom)` The date available used for the search is that for the main product and not for the product variations.
`void`	`setDateAvailableTo(java.util.Calendar dateAvailableTo)` The date available used for the search is that for the main product and not for the product variations.
`void`	`setEndDateFrom(java.util.Calendar endDateFrom)` Used for Bookable Products
`void`	`setEndDateTo(java.util.Calendar endDateTo)` Used for Bookable Products
`void`	`setExpiryDateFrom(java.util.Calendar expiryDateFrom)` Used to search for products based on the expiry date
`void`	`setExpiryDateTo(java.util.Calendar expiryDateTo)` Used to search for products based on the expiry date
`void`	`setFillDescription(boolean fillDescription)` Fills the product description attribute with the description in the chosen language.
`void`	`setForceUseSolr(boolean forceUseSolr)` When set to true, Solr is used even though KonaKart may not have used Solr.
`void`	`setManufacturerId(int manufacturerId)` Used as a constraint when not set to ProductSearch.SEARCH_ALL and when manufacturerIds is null or empty.
`void`	`setManufacturerIds(int[] manufacturerIds)` When not null and containing data, the manufacturer ids in this array are used to provide constraints and the manufacturerId attribute is ignored.
`void`	`setOrderedEqual(java.lang.Integer orderedEqual)` Returns all products that have been ordered a number of times equal to the value.
`void`	`setOrderedGreaterThan(java.lang.Integer orderedGreaterThan)` Returns all products that have been ordered more times than the value.
`void`	`setOrderedLessThan(java.lang.Integer orderedLessThan)` Returns all products that have been ordered less times than the value.
`void`	`setOverlapEndDate(java.util.Calendar overlapEndDate)` When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object.
`void`	`setOverlapStartDate(java.util.Calendar overlapStartDate)` When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object.
`void`	`setPriceFacetOptions(PriceFacetOptionsIf priceFacetOptions)` Used to configure price facets.
`void`	`setPriceFrom(java.math.BigDecimal priceFrom)`
`void`	`setPriceTo(java.math.BigDecimal priceTo)`
`void`	`setPriceTypeRequired(java.lang.String priceTypeRequired)`
`void`	`setProductId(int productId)` Set this to search for a product by its id.
`void`	`setProductType(int productType)` Set this to search for products with a specific product type.
`void`	`setQuantityEqual(java.lang.Integer quantityEqual)` Returns all products with a quantity equal to the value.
`void`	`setQuantityGreaterThan(java.lang.Integer quantityGreaterThan)` Returns all products with a quantity greater than the value.
`void`	`setQuantityLessThan(java.lang.Integer quantityLessThan)` Returns all products with a quantity less than the value.
`void`	`setRatingEqual(java.math.BigDecimal ratingEqual)` Returns all products with a rating equal to the value.
`void`	`setRatingGreaterThan(java.math.BigDecimal ratingGreaterThan)` Returns all products with a rating greater than the value.
`void`	`setRatingLessThan(java.math.BigDecimal ratingLessThan)` Returns all products with a rating less than the value.
`void`	`setReturnCategoryFacets(boolean returnCategoryFacets)` When set, the result of a product search using Solr contains the category facets including the number of products per category.
`void`	`setReturnCustomFacets(boolean returnCustomFacets)` When set, the result of a product search using Solr contains the custom facets.
`void`	`setReturnExtras(java.lang.Boolean returnExtras)`
`void`	`setReturnManufacturerFacets(boolean returnManufacturerFacets)` When set, the result of a product search using Solr contains the manufacturer facets including the number of products per manufacturer.
`void`	`setReturnSearchScore(boolean returnSearchScore)` When set and Solr is enabled, the search results include the Solr score
`void`	`setSearchAllStores(boolean searchAllStores)` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`void`	`setSearchInCustomd5(boolean searchInCustomd5)` Determines whether products are searched in customd5 attributes
`void`	`setSearchInSubCats(boolean searchInSubCats)` Determines whether products are searched for in child categories when there are category constraints.
`void`	`setSearchText(java.lang.String searchText)`
`void`	`setSearchTextRule(int searchTextRule)` The rule for the search.
`void`	`setSnippetOptions(SnippetOptionsIf snippetOptions)` Used to configure fragments of text returned by the search engine that surround the keywords.
`void`	`setStartDateFrom(java.util.Calendar startDateFrom)` Used for Bookable Products
`void`	`setStartDateTo(java.util.Calendar startDateTo)` Used for Bookable Products
`void`	`setStoresToSearch(java.lang.String[] storesToSearch)` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`void`	`setTagGroups(TagGroupIf[] tagGroups)` For a single tag group, all products are returned that have any one of the tags in the group (i.e.
`void`	`setTcposArticleId(java.lang.Integer tcposArticleId)`
`void`	`setTcposShopId(java.lang.Integer tcposShopId)` Used to check whether this product is Blocked for this shopID
`void`	`setTcposTypeId(java.lang.String tcposTypeId)`
`void`	`setTcposValidityDate(java.util.Calendar tcposValidityDate)`
`void`	`setTokenizeSolrInput(boolean tokenizeSolrInput)` Determines whether to tokenize Solr search string on whitespace
`void`	`setWhereToSearch(int whereToSearch)` When set to 0, the text search is done only on the product name.
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SEARCH_IN_PRODUCT_DESCRIPTION
```
public static final int SEARCH_IN_PRODUCT_DESCRIPTION
```
    SEARCH_IN_PRODUCT_DESCRIPTION
    
    See Also:
    
    Constant Field Values
  - SEARCH_ALL
```
public static final int SEARCH_ALL
```
    SEARCH_ALL = -100
    
    See Also:
    
    Constant Field Values
  - NOT_SET
```
public static final int NOT_SET
```
    NOT_SET = -1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProductSearch
```
public ProductSearch()
```
    Constructor
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Product object and those of its Options.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing selected attributes of the Product object
  - getCategoryId
```
public int getCategoryId()
```
    Used as a constraint when not set to ProductSearch.SEARCH_ALL and when categoryIds is null or empty. If the category is a parent category, it only applies to products directly under this category and not to products within child categories unless searchInSubCats is set to true.
    
    Specified by:
    
    getCategoryId in interface ProductSearchIf
    
    Returns:
    
    Returns the categoryId.
  - setCategoryId
```
public void setCategoryId(int categoryId)
```
    Used as a constraint when not set to ProductSearch.SEARCH_ALL and when categoryIds is null or empty. If the category is a parent category, it only applies to products directly under this category and not to products within child categories unless searchInSubCats is set to true.
    
    Specified by:
    
    setCategoryId in interface ProductSearchIf
    
    Parameters:
    
    categoryId - The categoryId to set.
  - getManufacturerId
```
public int getManufacturerId()
```
    Used as a constraint when not set to ProductSearch.SEARCH_ALL and when manufacturerIds is null or empty.
    
    Specified by:
    
    getManufacturerId in interface ProductSearchIf
    
    Returns:
    
    Returns the manufacturerId.
  - setManufacturerId
```
public void setManufacturerId(int manufacturerId)
```
    Used as a constraint when not set to ProductSearch.SEARCH_ALL and when manufacturerIds is null or empty.
    
    Specified by:
    
    setManufacturerId in interface ProductSearchIf
    
    Parameters:
    
    manufacturerId - The manufacturerId to set.
  - getPriceFrom
```
public java.math.BigDecimal getPriceFrom()
```
    Specified by:
    
    getPriceFrom in interface ProductSearchIf
    
    Returns:
    
    Returns the priceFrom.
  - setPriceFrom
```
public void setPriceFrom(java.math.BigDecimal priceFrom)
```
    Specified by:
    
    setPriceFrom in interface ProductSearchIf
    
    Parameters:
    
    priceFrom - The priceFrom to set.
  - getPriceTo
```
public java.math.BigDecimal getPriceTo()
```
    Specified by:
    
    getPriceTo in interface ProductSearchIf
    
    Returns:
    
    Returns the priceTo.
  - setPriceTo
```
public void setPriceTo(java.math.BigDecimal priceTo)
```
    Specified by:
    
    setPriceTo in interface ProductSearchIf
    
    Parameters:
    
    priceTo - The priceTo to set.
  - getSearchText
```
public java.lang.String getSearchText()
```
    Specified by:
    
    getSearchText in interface ProductSearchIf
    
    Returns:
    
    Returns the searchText.
  - setSearchText
```
public void setSearchText(java.lang.String searchText)
```
    Specified by:
    
    setSearchText in interface ProductSearchIf
    
    Parameters:
    
    searchText - The searchText to set.
  - getWhereToSearch
```
public int getWhereToSearch()
```
    Description copied from interface: ProductSearchIf
    
    When set to 0, the text search is done only on the product name. When set to com.konakart.app.ProductSearch.SEARCH_IN_PRODUCT_DESCRIPTION the search is done in the product description also.
    
    Specified by:
    
    getWhereToSearch in interface ProductSearchIf
    
    Returns:
    
    Returns the whereToSearch.
  - setWhereToSearch
```
public void setWhereToSearch(int whereToSearch)
```
    Description copied from interface: ProductSearchIf
    
    When set to 0, the text search is done only on the product name. When set to com.konakart.app.ProductSearch.SEARCH_IN_PRODUCT_DESCRIPTION the search is done in the product description also.
    
    Specified by:
    
    setWhereToSearch in interface ProductSearchIf
    
    Parameters:
    
    whereToSearch - The whereToSearch to set.
  - getDateAddedFrom
```
public java.util.Calendar getDateAddedFrom()
```
    Specified by:
    
    getDateAddedFrom in interface ProductSearchIf
    
    Returns:
    
    Returns the dateAddedFrom.
  - setDateAddedFrom
```
public void setDateAddedFrom(java.util.Calendar dateAddedFrom)
```
    Specified by:
    
    setDateAddedFrom in interface ProductSearchIf
    
    Parameters:
    
    dateAddedFrom - The dateAddedFrom to set.
  - getDateAddedTo
```
public java.util.Calendar getDateAddedTo()
```
    Specified by:
    
    getDateAddedTo in interface ProductSearchIf
    
    Returns:
    
    Returns the dateAddedTo.
  - setDateAddedTo
```
public void setDateAddedTo(java.util.Calendar dateAddedTo)
```
    Specified by:
    
    setDateAddedTo in interface ProductSearchIf
    
    Parameters:
    
    dateAddedTo - The dateAddedTo to set.
  - getSEARCH_ALL
```
public static int getSEARCH_ALL()
```
    Returns:
    
    Returns the sEARCH_ALL.
  - isSearchInSubCats
```
public boolean isSearchInSubCats()
```
    Determines whether products are searched for in child categories when there are category constraints.
    
    Specified by:
    
    isSearchInSubCats in interface ProductSearchIf
    
    Returns:
    
    Returns the searchInSubCats.
  - setSearchInSubCats
```
public void setSearchInSubCats(boolean searchInSubCats)
```
    Determines whether products are searched for in child categories when there are category constraints.
    
    Specified by:
    
    setSearchInSubCats in interface ProductSearchIf
    
    Parameters:
    
    searchInSubCats - The searchInSubCats to set.
  - getTagGroups
```
public TagGroupIf[] getTagGroups()
```
    Description copied from interface: ProductSearchIf
    
    For a single tag group, all products are returned that have any one of the tags in the group (i.e. All products that have tag1 OR tag2 OR tag3). If there is more than one tag group, then the only products returned are the ones that satisfy the filters of all the groups. i.e. In order to be returned, a product has to satisfy the filters of tag group1 AND tag group2 AND tag group3.
    For example in the case of digital cameras, one tag group could contain tags for the number of megapixels and another group could contain tags for the battery type. Using the above logic it is straightforward to search for a camera that has a 4MPixel OR a 6MPixel sensor AND has a rechargeable battery.
    
    Specified by:
    
    getTagGroups in interface ProductSearchIf
    
    Returns:
    
    Returns the tagGroups.
  - setTagGroups
```
public void setTagGroups(TagGroupIf[] tagGroups)
```
    Description copied from interface: ProductSearchIf
    
    For a single tag group, all products are returned that have any one of the tags in the group (i.e. All products that have tag1 OR tag2 OR tag3). If there is more than one tag group, then the only products returned are the ones that satisfy the filters of all the groups. i.e. In order to be returned, a product has to satisfy the filters of tag group1 AND tag group2 AND tag group3.
    For example in the case of digital cameras, one tag group could contain tags for the number of megapixels and another group could contain tags for the battery type. Using the above logic it is straightforward to search for a camera that has a 4MPixel OR a 6MPixel sensor AND has a rechargeable battery.
    
    Specified by:
    
    setTagGroups in interface ProductSearchIf
    
    Parameters:
    
    tagGroups - The tagGroups to set.
  - isSearchAllStores
```
public boolean isSearchAllStores()
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. When set, the search will traverse all stores. Each returned product will have a storeId attribute that identifies in which store the product was found.
    
    Specified by:
    
    isSearchAllStores in interface ProductSearchIf
    
    Returns:
    
    Returns a boolean that specifies whether to search in all stores.
  - setSearchAllStores
```
public void setSearchAllStores(boolean searchAllStores)
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. When set, the search will traverse all stores. Each returned product will have a storeId attribute that identifies in which store the product was found.
    
    Specified by:
    
    setSearchAllStores in interface ProductSearchIf
    
    Parameters:
    
    searchAllStores - A boolean that specifies whether to search in all stores.
  - getStoresToSearch
```
public java.lang.String[] getStoresToSearch()
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. The array may contain store ids in order to configure the search process to search in all of the stores in the array. If searchAllStores is set, then this array is ignored.
    
    Specified by:
    
    getStoresToSearch in interface ProductSearchIf
    
    Returns:
    
    Returns an array of store ids
  - setStoresToSearch
```
public void setStoresToSearch(java.lang.String[] storesToSearch)
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. The array may contain store ids in order to configure the search process to search in all of the stores in the array. If searchAllStores is set, then this array is ignored.
    
    Specified by:
    
    setStoresToSearch in interface ProductSearchIf
    
    Parameters:
    
    storesToSearch - the storesToSearch
  - getSnippetOptions
```
public SnippetOptionsIf getSnippetOptions()
```
    Used to configure fragments of text returned by the search engine that surround the keywords. Can be set to null.
    
    Specified by:
    
    getSnippetOptions in interface ProductSearchIf
    
    Returns:
    
    the snippetOptions
  - setSnippetOptions
```
public void setSnippetOptions(SnippetOptionsIf snippetOptions)
```
    Used to configure fragments of text returned by the search engine that surround the keywords. Can be set to null.
    
    Specified by:
    
    setSnippetOptions in interface ProductSearchIf
    
    Parameters:
    
    snippetOptions - the snippetOptions to set
  - getRatingGreaterThan
```
public java.math.BigDecimal getRatingGreaterThan()
```
    Returns all products with a rating greater than the value.
    
    Specified by:
    
    getRatingGreaterThan in interface ProductSearchIf
    
    Returns:
    
    the ratingGreaterThan
  - setRatingGreaterThan
```
public void setRatingGreaterThan(java.math.BigDecimal ratingGreaterThan)
```
    Returns all products with a rating greater than the value.
    
    Specified by:
    
    setRatingGreaterThan in interface ProductSearchIf
    
    Parameters:
    
    ratingGreaterThan - the ratingGreaterThan to set
  - getRatingLessThan
```
public java.math.BigDecimal getRatingLessThan()
```
    Returns all products with a rating less than the value.
    
    Specified by:
    
    getRatingLessThan in interface ProductSearchIf
    
    Returns:
    
    the ratingLessThan
  - setRatingLessThan
```
public void setRatingLessThan(java.math.BigDecimal ratingLessThan)
```
    Returns all products with a rating less than the value.
    
    Specified by:
    
    setRatingLessThan in interface ProductSearchIf
    
    Parameters:
    
    ratingLessThan - the ratingLessThan to set
  - getRatingEqual
```
public java.math.BigDecimal getRatingEqual()
```
    Returns all products with a rating equal to the value.
    
    Specified by:
    
    getRatingEqual in interface ProductSearchIf
    
    Returns:
    
    the ratingEqual
  - setRatingEqual
```
public void setRatingEqual(java.math.BigDecimal ratingEqual)
```
    Returns all products with a rating equal to the value.
    
    Specified by:
    
    setRatingEqual in interface ProductSearchIf
    
    Parameters:
    
    ratingEqual - the ratingEqual to set
  - getDateAvailableTo
```
public java.util.Calendar getDateAvailableTo()
```
    Description copied from interface: ProductSearchIf
    
    The date available used for the search is that for the main product and not for the product variations.
    
    Specified by:
    
    getDateAvailableTo in interface ProductSearchIf
    
    Returns:
    
    the dateAvailableTo
  - setDateAvailableTo
```
public void setDateAvailableTo(java.util.Calendar dateAvailableTo)
```
    Description copied from interface: ProductSearchIf
    
    The date available used for the search is that for the main product and not for the product variations.
    
    Specified by:
    
    setDateAvailableTo in interface ProductSearchIf
    
    Parameters:
    
    dateAvailableTo - the dateAvailableTo to set
  - getDateAvailableFrom
```
public java.util.Calendar getDateAvailableFrom()
```
    Description copied from interface: ProductSearchIf
    
    The date available used for the search is that for the main product and not for the product variations.
    
    Specified by:
    
    getDateAvailableFrom in interface ProductSearchIf
    
    Returns:
    
    the dateAvailableFrom
  - setDateAvailableFrom
```
public void setDateAvailableFrom(java.util.Calendar dateAvailableFrom)
```
    Description copied from interface: ProductSearchIf
    
    The date available used for the search is that for the main product and not for the product variations.
    
    Specified by:
    
    setDateAvailableFrom in interface ProductSearchIf
    
    Parameters:
    
    dateAvailableFrom - the dateAvailableFrom to set
  - isFillDescription
```
public boolean isFillDescription()
```
    Description copied from interface: ProductSearchIf
    
    Fills the product description attribute with the description in the chosen language. Normally this is not returned for performance reasons.
    
    Specified by:
    
    isFillDescription in interface ProductSearchIf
    
    Returns:
    
    the fillDescription
  - setFillDescription
```
public void setFillDescription(boolean fillDescription)
```
    Description copied from interface: ProductSearchIf
    
    Fills the product description attribute with the description in the chosen language. Normally this is not returned for performance reasons.
    
    Specified by:
    
    setFillDescription in interface ProductSearchIf
    
    Parameters:
    
    fillDescription - the fillDescription to set
  - getSearchTextRule
```
public int getSearchTextRule()
```
    Description copied from interface: ProductSearchIf
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    Specified by:
    
    getSearchTextRule in interface ProductSearchIf
    
    Returns:
    
    the searchTextRule
  - setSearchTextRule
```
public void setSearchTextRule(int searchTextRule)
```
    Description copied from interface: ProductSearchIf
    The rule for the search. Valid values are:
    - KKConstants.SEARCH_EXACT
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE
    - KKConstants.SEARCH_ADD_WILDCARD_AFTER
    - KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
    Specified by:
    
    setSearchTextRule in interface ProductSearchIf
    
    Parameters:
    
    searchTextRule - the searchTextRule to set
  - getExpiryDateTo
```
public java.util.Calendar getExpiryDateTo()
```
    Description copied from interface: ProductSearchIf
    
    Used to search for products based on the expiry date
    
    Specified by:
    
    getExpiryDateTo in interface ProductSearchIf
    
    Returns:
    
    the expiryDateTo
  - setExpiryDateTo
```
public void setExpiryDateTo(java.util.Calendar expiryDateTo)
```
    Description copied from interface: ProductSearchIf
    
    Used to search for products based on the expiry date
    
    Specified by:
    
    setExpiryDateTo in interface ProductSearchIf
    
    Parameters:
    
    expiryDateTo - the expiryDateTo to set
  - getExpiryDateFrom
```
public java.util.Calendar getExpiryDateFrom()
```
    Description copied from interface: ProductSearchIf
    
    Used to search for products based on the expiry date
    
    Specified by:
    
    getExpiryDateFrom in interface ProductSearchIf
    
    Returns:
    
    the expiryDateFrom
  - setExpiryDateFrom
```
public void setExpiryDateFrom(java.util.Calendar expiryDateFrom)
```
    Description copied from interface: ProductSearchIf
    
    Used to search for products based on the expiry date
    
    Specified by:
    
    setExpiryDateFrom in interface ProductSearchIf
    
    Parameters:
    
    expiryDateFrom - the expiryDateFrom to set
  - getQuantityGreaterThan
```
public java.lang.Integer getQuantityGreaterThan()
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity greater than the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    getQuantityGreaterThan in interface ProductSearchIf
    
    Returns:
    
    the quantityGreaterThan
  - setQuantityGreaterThan
```
public void setQuantityGreaterThan(java.lang.Integer quantityGreaterThan)
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity greater than the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    setQuantityGreaterThan in interface ProductSearchIf
    
    Parameters:
    
    quantityGreaterThan - the quantityGreaterThan to set
  - getQuantityLessThan
```
public java.lang.Integer getQuantityLessThan()
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity less than the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    getQuantityLessThan in interface ProductSearchIf
    
    Returns:
    
    the quantityLessThan
  - setQuantityLessThan
```
public void setQuantityLessThan(java.lang.Integer quantityLessThan)
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity less than the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    setQuantityLessThan in interface ProductSearchIf
    
    Parameters:
    
    quantityLessThan - the quantityLessThan to set
  - getQuantityEqual
```
public java.lang.Integer getQuantityEqual()
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity equal to the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    getQuantityEqual in interface ProductSearchIf
    
    Returns:
    
    the quantityEqual
  - setQuantityEqual
```
public void setQuantityEqual(java.lang.Integer quantityEqual)
```
    Description copied from interface: ProductSearchIf
    
    Returns all products with a quantity equal to the value. Note that it uses the quantity attribute of the product object and doesn't use the quantities of product variations.
    
    Specified by:
    
    setQuantityEqual in interface ProductSearchIf
    
    Parameters:
    
    quantityEqual - the quantityEqual to set
  - getStartDateFrom
```
public java.util.Calendar getStartDateFrom()
```
    Used for Bookable Products
    
    Specified by:
    
    getStartDateFrom in interface ProductSearchIf
    
    Returns:
    
    the startDateFrom
  - setStartDateFrom
```
public void setStartDateFrom(java.util.Calendar startDateFrom)
```
    Used for Bookable Products
    
    Specified by:
    
    setStartDateFrom in interface ProductSearchIf
    
    Parameters:
    
    startDateFrom - the startDateFrom to set
  - getStartDateTo
```
public java.util.Calendar getStartDateTo()
```
    Used for Bookable Products
    
    Specified by:
    
    getStartDateTo in interface ProductSearchIf
    
    Returns:
    
    the startDateTo
  - setStartDateTo
```
public void setStartDateTo(java.util.Calendar startDateTo)
```
    Used for Bookable Products
    
    Specified by:
    
    setStartDateTo in interface ProductSearchIf
    
    Parameters:
    
    startDateTo - the startDateTo to set
  - getEndDateFrom
```
public java.util.Calendar getEndDateFrom()
```
    Used for Bookable Products
    
    Specified by:
    
    getEndDateFrom in interface ProductSearchIf
    
    Returns:
    
    the endDateFrom
  - setEndDateFrom
```
public void setEndDateFrom(java.util.Calendar endDateFrom)
```
    Used for Bookable Products
    
    Specified by:
    
    setEndDateFrom in interface ProductSearchIf
    
    Parameters:
    
    endDateFrom - the endDateFrom to set
  - getEndDateTo
```
public java.util.Calendar getEndDateTo()
```
    Used for Bookable Products
    
    Specified by:
    
    getEndDateTo in interface ProductSearchIf
    
    Returns:
    
    the endDateTo
  - setEndDateTo
```
public void setEndDateTo(java.util.Calendar endDateTo)
```
    Used for Bookable Products
    
    Specified by:
    
    setEndDateTo in interface ProductSearchIf
    
    Parameters:
    
    endDateTo - the endDateTo to set
  - getOverlapStartDate
```
public java.util.Calendar getOverlapStartDate()
```
    When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object. This search does not use the Solr search engine.
    
    Specified by:
    
    getOverlapStartDate in interface ProductSearchIf
    
    Returns:
    
    the overlapStartDate
  - setOverlapStartDate
```
public void setOverlapStartDate(java.util.Calendar overlapStartDate)
```
    When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object. This search does not use the Solr search engine.
    
    Specified by:
    
    setOverlapStartDate in interface ProductSearchIf
    
    Parameters:
    
    overlapStartDate - the overlapStartDate to set
  - getOverlapEndDate
```
public java.util.Calendar getOverlapEndDate()
```
    When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object. This search does not use the Solr search engine.
    
    Specified by:
    
    getOverlapEndDate in interface ProductSearchIf
    
    Returns:
    
    the overlapEndDate
  - setOverlapEndDate
```
public void setOverlapEndDate(java.util.Calendar overlapEndDate)
```
    When overlapStart and end dates are both set, a search is done for all products that have start and end dates that make them overlap the dates set in this search object. This search does not use the Solr search engine.
    
    Specified by:
    
    setOverlapEndDate in interface ProductSearchIf
    
    Parameters:
    
    overlapEndDate - the overlapEndDate to set
  - getProductType
```
public int getProductType()
```
    Specified by:
    
    getProductType in interface ProductSearchIf
    
    Returns:
    
    the productType
  - setProductType
```
public void setProductType(int productType)
```
    Description copied from interface: ProductSearchIf
    
    Set this to search for products with a specific product type. This is only used if the value is greater than or equal to 0.
    
    Specified by:
    
    setProductType in interface ProductSearchIf
    
    Parameters:
    
    productType - the productType to set
  - isReturnManufacturerFacets
```
public boolean isReturnManufacturerFacets()
```
    When set, the result of a product search using Solr contains the manufacturer facets including the number of products per manufacturer.
    
    Specified by:
    
    isReturnManufacturerFacets in interface ProductSearchIf
    
    Returns:
    
    the returnManufacturerFacets
  - setReturnManufacturerFacets
```
public void setReturnManufacturerFacets(boolean returnManufacturerFacets)
```
    When set, the result of a product search using Solr contains the manufacturer facets including the number of products per manufacturer.
    
    Specified by:
    
    setReturnManufacturerFacets in interface ProductSearchIf
    
    Parameters:
    
    returnManufacturerFacets - the returnManufacturerFacets to set
  - isReturnCategoryFacets
```
public boolean isReturnCategoryFacets()
```
    When set, the result of a product search using Solr contains the category facets including the number of products per category.
    
    Specified by:
    
    isReturnCategoryFacets in interface ProductSearchIf
    
    Returns:
    
    the returnCategoryFacets
  - setReturnCategoryFacets
```
public void setReturnCategoryFacets(boolean returnCategoryFacets)
```
    When set, the result of a product search using Solr contains the category facets including the number of products per category.
    
    Specified by:
    
    setReturnCategoryFacets in interface ProductSearchIf
    
    Parameters:
    
    returnCategoryFacets - the returnCategoryFacets to set
  - getManufacturerIds
```
public int[] getManufacturerIds()
```
    When not null and containing data, the manufacturer ids in this array are used to provide constraints and the manufacturerId attribute is ignored.
    
    Specified by:
    
    getManufacturerIds in interface ProductSearchIf
    
    Returns:
    
    the manufacturerIds
  - setManufacturerIds
```
public void setManufacturerIds(int[] manufacturerIds)
```
    When not null and containing data, the manufacturer ids in this array are used to provide constraints and the manufacturerId attribute is ignored.
    
    Specified by:
    
    setManufacturerIds in interface ProductSearchIf
    
    Parameters:
    
    manufacturerIds - the manufacturerIds to set
  - getCategoryIds
```
public int[] getCategoryIds()
```
    When not null and containing data, the category ids in this array are used to provide constraints and the categoryId attribute is ignored.
    
    Specified by:
    
    getCategoryIds in interface ProductSearchIf
    
    Returns:
    
    the categoryIds
  - setCategoryIds
```
public void setCategoryIds(int[] categoryIds)
```
    When not null and containing data, the category ids in this array are used to provide constraints and the categoryId attribute is ignored.
    
    Specified by:
    
    setCategoryIds in interface ProductSearchIf
    
    Parameters:
    
    categoryIds - the categoryIds to set
  - getOrderedGreaterThan
```
public java.lang.Integer getOrderedGreaterThan()
```
    Returns all products that have been ordered more times than the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    getOrderedGreaterThan in interface ProductSearchIf
    
    Returns:
    
    the orderedGreaterThan
  - setOrderedGreaterThan
```
public void setOrderedGreaterThan(java.lang.Integer orderedGreaterThan)
```
    Returns all products that have been ordered more times than the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    setOrderedGreaterThan in interface ProductSearchIf
    
    Parameters:
    
    orderedGreaterThan - the orderedGreaterThan to set
  - getOrderedLessThan
```
public java.lang.Integer getOrderedLessThan()
```
    Returns all products that have been ordered less times than the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    getOrderedLessThan in interface ProductSearchIf
    
    Returns:
    
    the orderedLessThan
  - setOrderedLessThan
```
public void setOrderedLessThan(java.lang.Integer orderedLessThan)
```
    Returns all products that have been ordered less times than the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    setOrderedLessThan in interface ProductSearchIf
    
    Parameters:
    
    orderedLessThan - the orderedLessThan to set
  - getOrderedEqual
```
public java.lang.Integer getOrderedEqual()
```
    Returns all products that have been ordered a number of times equal to the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    getOrderedEqual in interface ProductSearchIf
    
    Returns:
    
    the orderedEqual
  - setOrderedEqual
```
public void setOrderedEqual(java.lang.Integer orderedEqual)
```
    Returns all products that have been ordered a number of times equal to the value. Note that it uses the ordered attribute of the product object.
    
    Specified by:
    
    setOrderedEqual in interface ProductSearchIf
    
    Parameters:
    
    orderedEqual - the orderedEqual to set
  - isReturnCustomFacets
```
public boolean isReturnCustomFacets()
```
    When set, the result of a product search using Solr contains the custom facets.
    
    Specified by:
    
    isReturnCustomFacets in interface ProductSearchIf
    
    Returns:
    
    the returnCustomFacets
  - setReturnCustomFacets
```
public void setReturnCustomFacets(boolean returnCustomFacets)
```
    When set, the result of a product search using Solr contains the custom facets.
    
    Specified by:
    
    setReturnCustomFacets in interface ProductSearchIf
    
    Parameters:
    
    returnCustomFacets - the returnCustomFacets to set
  - isForceUseSolr
```
public boolean isForceUseSolr()
```
    When set to true, Solr is used even though KonaKart may not have used Solr. Normally Solr is only used when doing text searches or when returning custom facets.
    
    Specified by:
    
    isForceUseSolr in interface ProductSearchIf
    
    Returns:
    
    the forceUseSolr
  - setForceUseSolr
```
public void setForceUseSolr(boolean forceUseSolr)
```
    When set to true, Solr is used even though KonaKart may not have used Solr. Normally Solr is only used when doing text searches or when returning custom facets.
    
    Specified by:
    
    setForceUseSolr in interface ProductSearchIf
    
    Parameters:
    
    forceUseSolr - the forceUseSolr to set
  - getPriceFacetOptions
```
public PriceFacetOptionsIf getPriceFacetOptions()
```
    Used to configure price facets. Can be set to null. Only used when Solr is enabled.
    
    Specified by:
    
    getPriceFacetOptions in interface ProductSearchIf
    
    Returns:
    
    the priceFacetOptions
  - setPriceFacetOptions
```
public void setPriceFacetOptions(PriceFacetOptionsIf priceFacetOptions)
```
    Used to configure price facets. Can be set to null. Only used when Solr is enabled.
    
    Specified by:
    
    setPriceFacetOptions in interface ProductSearchIf
    
    Parameters:
    
    priceFacetOptions - the priceFacetOptions to set
  - isTokenizeSolrInput
```
public boolean isTokenizeSolrInput()
```
    Determines whether to tokenize Solr search string on whitespace
    
    Specified by:
    
    isTokenizeSolrInput in interface ProductSearchIf
    
    Returns:
    
    the tokenizeSolrInput
  - setTokenizeSolrInput
```
public void setTokenizeSolrInput(boolean tokenizeSolrInput)
```
    Determines whether to tokenize Solr search string on whitespace
    
    Specified by:
    
    setTokenizeSolrInput in interface ProductSearchIf
    
    Parameters:
    
    tokenizeSolrInput - the tokenizeSolrInput to set
  - getPriceTypeRequired
```
public java.lang.String getPriceTypeRequired()
```
    Specified by:
    
    getPriceTypeRequired in interface ProductSearchIf
    
    Returns:
    
    the priceTypeRequired
  - setPriceTypeRequired
```
public void setPriceTypeRequired(java.lang.String priceTypeRequired)
```
    Specified by:
    
    setPriceTypeRequired in interface ProductSearchIf
    
    Parameters:
    
    priceTypeRequired - the priceTypeRequired to set
  - getTcposTypeId
```
public java.lang.String getTcposTypeId()
```
    Specified by:
    
    getTcposTypeId in interface ProductSearchIf
    
    Returns:
    
    the tcposTypeId
  - setTcposTypeId
```
public void setTcposTypeId(java.lang.String tcposTypeId)
```
    Specified by:
    
    setTcposTypeId in interface ProductSearchIf
    
    Parameters:
    
    tcposTypeId - the tcposTypeId to set
  - getTcposArticleId
```
public java.lang.Integer getTcposArticleId()
```
    Specified by:
    
    getTcposArticleId in interface ProductSearchIf
    
    Returns:
    
    the tcposArticleId
  - setTcposArticleId
```
public void setTcposArticleId(java.lang.Integer tcposArticleId)
```
    Specified by:
    
    setTcposArticleId in interface ProductSearchIf
    
    Parameters:
    
    tcposArticleId - the tcposArticleId to set
  - getReturnExtras
```
public java.lang.Boolean getReturnExtras()
```
    Specified by:
    
    getReturnExtras in interface ProductSearchIf
    
    Returns:
    
    the returnExtras
  - setReturnExtras
```
public void setReturnExtras(java.lang.Boolean returnExtras)
```
    Specified by:
    
    setReturnExtras in interface ProductSearchIf
    
    Parameters:
    
    returnExtras - the returnExtras to set
  - getTcposValidityDate
```
public java.util.Calendar getTcposValidityDate()
```
    Specified by:
    
    getTcposValidityDate in interface ProductSearchIf
    
    Returns:
    
    the tcposValidityDate
  - setTcposValidityDate
```
public void setTcposValidityDate(java.util.Calendar tcposValidityDate)
```
    Specified by:
    
    setTcposValidityDate in interface ProductSearchIf
    
    Parameters:
    
    tcposValidityDate - the tcposValidityDate to set
  - isReturnSearchScore
```
public boolean isReturnSearchScore()
```
    When set and Solr is enabled, the search results include the Solr score
    
    Specified by:
    
    isReturnSearchScore in interface ProductSearchIf
    
    Returns:
    
    the returnSearchScore
  - setReturnSearchScore
```
public void setReturnSearchScore(boolean returnSearchScore)
```
    When set and Solr is enabled, the search results include the Solr score
    
    Specified by:
    
    setReturnSearchScore in interface ProductSearchIf
    
    Parameters:
    
    returnSearchScore - the returnSearchScore to set
  - getProductId
```
public int getProductId()
```
    Specified by:
    
    getProductId in interface ProductSearchIf
    
    Returns:
    
    the productId
  - setProductId
```
public void setProductId(int productId)
```
    Description copied from interface: ProductSearchIf
    
    Set this to search for a product by its id. This is only used if the value is greater than or equal to 0.
    
    Specified by:
    
    setProductId in interface ProductSearchIf
    
    Parameters:
    
    productId - the productId to set
  - isSearchInCustomd5
```
public boolean isSearchInCustomd5()
```
    Determines whether products are searched in customd5 attributes
    
    Specified by:
    
    isSearchInCustomd5 in interface ProductSearchIf
    
    Returns:
    
    Returns the searchInCustomd5.
  - setSearchInCustomd5
```
public void setSearchInCustomd5(boolean searchInCustomd5)
```
    Determines whether products are searched in customd5 attributes
    
    Specified by:
    
    setSearchInCustomd5 in interface ProductSearchIf
    
    Parameters:
    
    searchInCustomd5 - The searchInCustomd5 to set.
  - getTcposShopId
```
public java.lang.Integer getTcposShopId()
```
    Description copied from interface: ProductSearchIf
    
    Used to check wheter this product is Blocked for this shopID
    
    Specified by:
    
    getTcposShopId in interface ProductSearchIf
    
    Returns:
    
    the tcposShopId
  - setTcposShopId
```
public void setTcposShopId(java.lang.Integer tcposShopId)
```
    Used to check whether this product is Blocked for this shopID
    
    Specified by:
    
    setTcposShopId in interface ProductSearchIf
    
    Parameters:
    
    tcposShopId - The shopID/manufacturerID to set.

Class ProductSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SEARCH_IN_PRODUCT_DESCRIPTION

SEARCH_ALL

NOT_SET

Constructor Detail

ProductSearch

Method Detail

toString

toStringBrief

getCategoryId

setCategoryId

getManufacturerId

setManufacturerId

getPriceFrom

setPriceFrom

getPriceTo

setPriceTo

getSearchText

setSearchText

getWhereToSearch

setWhereToSearch

getDateAddedFrom

setDateAddedFrom

getDateAddedTo

setDateAddedTo

getSEARCH_ALL

isSearchInSubCats

setSearchInSubCats

getTagGroups

setTagGroups

isSearchAllStores

setSearchAllStores

getStoresToSearch

setStoresToSearch

getSnippetOptions

setSnippetOptions

getRatingGreaterThan

setRatingGreaterThan

getRatingLessThan

setRatingLessThan

getRatingEqual

setRatingEqual

getDateAvailableTo

setDateAvailableTo

getDateAvailableFrom

setDateAvailableFrom

isFillDescription

setFillDescription

getSearchTextRule

setSearchTextRule

getExpiryDateTo

setExpiryDateTo

getExpiryDateFrom

setExpiryDateFrom

getQuantityGreaterThan

setQuantityGreaterThan

getQuantityLessThan

setQuantityLessThan

getQuantityEqual

setQuantityEqual

getStartDateFrom

setStartDateFrom

getStartDateTo

setStartDateTo

getEndDateFrom

setEndDateFrom

getEndDateTo

setEndDateTo

getOverlapStartDate

setOverlapStartDate

getOverlapEndDate

setOverlapEndDate

getProductType

setProductType

isReturnManufacturerFacets