|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ProductSearchIf
Contains information used to search the catalog for a product. Whenever an attribute is set, it is used as a constraint. When using the java API, a com.konakart.app.ProductSearch object is normally instantiated. Note that when this object initializes it sets the following attributes:
| Method Summary | |
|---|---|
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. |
java.math.BigDecimal |
getPriceFrom()
|
java.math.BigDecimal |
getPriceTo()
|
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.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()
|
TagGroupIf[] |
getTagGroups()
For a single tag group, all products are returned that have any one of the tags in the group (i.e. |
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 |
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 |
isSearchAllStores()
|
boolean |
isSearchInSubCats()
Determines whether products are searched for in child categories when there are category constraints. |
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 |
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 |
setPriceFrom(java.math.BigDecimal priceFrom)
|
void |
setPriceTo(java.math.BigDecimal priceTo)
|
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 |
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 |
setSearchAllStores(boolean searchAllStores)
|
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)
|
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 |
setWhereToSearch(int whereToSearch)
When set to 0, the text search is done only on the product name. |
| Method Detail |
|---|
int getCategoryId()
void setCategoryId(int categoryId)
categoryId - The categoryId to set.int getManufacturerId()
void setManufacturerId(int manufacturerId)
manufacturerId - The manufacturerId to set.java.math.BigDecimal getPriceFrom()
void setPriceFrom(java.math.BigDecimal priceFrom)
priceFrom - The priceFrom to set.java.math.BigDecimal getPriceTo()
void setPriceTo(java.math.BigDecimal priceTo)
priceTo - The priceTo to set.java.lang.String getSearchText()
void setSearchText(java.lang.String searchText)
searchText - The searchText to set.int getWhereToSearch()
void setWhereToSearch(int whereToSearch)
whereToSearch - The whereToSearch to set.java.util.Calendar getDateAddedFrom()
void setDateAddedFrom(java.util.Calendar dateAddedFrom)
dateAddedFrom - The dateAddedFrom to set.java.util.Calendar getDateAddedTo()
void setDateAddedTo(java.util.Calendar dateAddedTo)
dateAddedTo - The dateAddedTo to set.boolean isSearchInSubCats()
void setSearchInSubCats(boolean searchInSubCats)
searchInSubCats - The searchInSubCats to set.TagGroupIf[] getTagGroups()
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.
void setTagGroups(TagGroupIf[] tagGroups)
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.
tagGroups - The tagGroups to set.boolean isSearchAllStores()
void setSearchAllStores(boolean searchAllStores)
searchAllStores - java.lang.String[] getStoresToSearch()
void setStoresToSearch(java.lang.String[] storesToSearch)
storesToSearch - SnippetOptionsIf getSnippetOptions()
void setSnippetOptions(SnippetOptionsIf snippetOptions)
snippetOptions - the snippetOptions to setjava.math.BigDecimal getRatingGreaterThan()
void setRatingGreaterThan(java.math.BigDecimal ratingGreaterThan)
ratingGreaterThan - the ratingGreaterThan to setjava.math.BigDecimal getRatingLessThan()
void setRatingLessThan(java.math.BigDecimal ratingLessThan)
ratingLessThan - the ratingLessThan to setjava.math.BigDecimal getRatingEqual()
void setRatingEqual(java.math.BigDecimal ratingEqual)
ratingEqual - the ratingEqual to setjava.util.Calendar getDateAvailableTo()
void setDateAvailableTo(java.util.Calendar dateAvailableTo)
dateAvailableTo - the dateAvailableTo to setjava.util.Calendar getDateAvailableFrom()
void setDateAvailableFrom(java.util.Calendar dateAvailableFrom)
dateAvailableFrom - the dateAvailableFrom to setjava.util.Calendar getExpiryDateTo()
void setExpiryDateTo(java.util.Calendar expiryDateTo)
expiryDateTo - the expiryDateTo to setjava.util.Calendar getExpiryDateFrom()
void setExpiryDateFrom(java.util.Calendar expiryDateFrom)
expiryDateFrom - the expiryDateFrom to setboolean isFillDescription()
void setFillDescription(boolean fillDescription)
fillDescription - the fillDescription to setint getSearchTextRule()
void setSearchTextRule(int searchTextRule)
searchTextRule - the searchTextRule to setjava.lang.Integer getQuantityGreaterThan()
void setQuantityGreaterThan(java.lang.Integer quantityGreaterThan)
quantityGreaterThan - the quantityGreaterThan to setjava.lang.Integer getQuantityLessThan()
void setQuantityLessThan(java.lang.Integer quantityLessThan)
quantityLessThan - the quantityLessThan to setjava.lang.Integer getQuantityEqual()
void setQuantityEqual(java.lang.Integer quantityEqual)
quantityEqual - the quantityEqual to setjava.util.Calendar getStartDateFrom()
void setStartDateFrom(java.util.Calendar startDateFrom)
startDateFrom - the startDateFrom to setjava.util.Calendar getStartDateTo()
void setStartDateTo(java.util.Calendar startDateTo)
startDateTo - the startDateTo to setjava.util.Calendar getEndDateFrom()
void setEndDateFrom(java.util.Calendar endDateFrom)
endDateFrom - the endDateFrom to setjava.util.Calendar getEndDateTo()
void setEndDateTo(java.util.Calendar endDateTo)
endDateTo - the endDateTo to setjava.util.Calendar getOverlapStartDate()
void setOverlapStartDate(java.util.Calendar overlapStartDate)
overlapStartDate - the overlapStartDate to setjava.util.Calendar getOverlapEndDate()
void setOverlapEndDate(java.util.Calendar overlapEndDate)
overlapEndDate - the overlapEndDate to setint getProductType()
void setProductType(int productType)
productType - the productType to setboolean isReturnManufacturerFacets()
void setReturnManufacturerFacets(boolean returnManufacturerFacets)
returnManufacturerFacets - the returnManufacturerFacets to setboolean isReturnCategoryFacets()
void setReturnCategoryFacets(boolean returnCategoryFacets)
returnCategoryFacets - the returnCategoryFacets to setint[] getManufacturerIds()
void setManufacturerIds(int[] manufacturerIds)
manufacturerIds - the manufacturerIds to setint[] getCategoryIds()
void setCategoryIds(int[] categoryIds)
categoryIds - the categoryIds to setjava.lang.Integer getOrderedGreaterThan()
void setOrderedGreaterThan(java.lang.Integer orderedGreaterThan)
orderedGreaterThan - the orderedGreaterThan to setjava.lang.Integer getOrderedLessThan()
void setOrderedLessThan(java.lang.Integer orderedLessThan)
orderedLessThan - the orderedLessThan to setjava.lang.Integer getOrderedEqual()
void setOrderedEqual(java.lang.Integer orderedEqual)
orderedEqual - the orderedEqual to setboolean isReturnCustomFacets()
void setReturnCustomFacets(boolean returnCustomFacets)
returnCustomFacets - the returnCustomFacets to set
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||