|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.konakart.rmi.app.S_ProductSearch
public class S_ProductSearch
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:
| Constructor Summary | |
|---|---|
S_ProductSearch()
|
|
| 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. |
S_SnippetOptions |
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()
|
S_TagGroup[] |
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(S_SnippetOptions _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(S_TagGroup[] _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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public S_ProductSearch()
| Method Detail |
|---|
public int getCategoryId()
public void setCategoryId(int _categoryId)
_categoryId - The categoryId to set.public int getManufacturerId()
public void setManufacturerId(int _manufacturerId)
_manufacturerId - The manufacturerId to set.public java.math.BigDecimal getPriceFrom()
public void setPriceFrom(java.math.BigDecimal _priceFrom)
_priceFrom - The priceFrom to set.public java.math.BigDecimal getPriceTo()
public void setPriceTo(java.math.BigDecimal _priceTo)
_priceTo - The priceTo to set.public java.lang.String getSearchText()
public void setSearchText(java.lang.String _searchText)
_searchText - The searchText to set.public int getWhereToSearch()
public void setWhereToSearch(int _whereToSearch)
_whereToSearch - The whereToSearch to set.public java.util.Calendar getDateAddedFrom()
public void setDateAddedFrom(java.util.Calendar _dateAddedFrom)
_dateAddedFrom - The dateAddedFrom to set.public java.util.Calendar getDateAddedTo()
public void setDateAddedTo(java.util.Calendar _dateAddedTo)
_dateAddedTo - The dateAddedTo to set.public boolean isSearchInSubCats()
public void setSearchInSubCats(boolean _searchInSubCats)
_searchInSubCats - The searchInSubCats to set.public S_TagGroup[] 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.
public void setTagGroups(S_TagGroup[] _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.public boolean isSearchAllStores()
public void setSearchAllStores(boolean _searchAllStores)
_searchAllStores - public java.lang.String[] getStoresToSearch()
public void setStoresToSearch(java.lang.String[] _storesToSearch)
_storesToSearch - public S_SnippetOptions getSnippetOptions()
public void setSnippetOptions(S_SnippetOptions _snippetOptions)
_snippetOptions - the snippetOptions to setpublic java.math.BigDecimal getRatingGreaterThan()
public void setRatingGreaterThan(java.math.BigDecimal _ratingGreaterThan)
_ratingGreaterThan - the ratingGreaterThan to setpublic java.math.BigDecimal getRatingLessThan()
public void setRatingLessThan(java.math.BigDecimal _ratingLessThan)
_ratingLessThan - the ratingLessThan to setpublic java.math.BigDecimal getRatingEqual()
public void setRatingEqual(java.math.BigDecimal _ratingEqual)
_ratingEqual - the ratingEqual to setpublic java.util.Calendar getDateAvailableTo()
public void setDateAvailableTo(java.util.Calendar _dateAvailableTo)
_dateAvailableTo - the dateAvailableTo to setpublic java.util.Calendar getDateAvailableFrom()
public void setDateAvailableFrom(java.util.Calendar _dateAvailableFrom)
_dateAvailableFrom - the dateAvailableFrom to setpublic java.util.Calendar getExpiryDateTo()
public void setExpiryDateTo(java.util.Calendar _expiryDateTo)
_expiryDateTo - the expiryDateTo to setpublic java.util.Calendar getExpiryDateFrom()
public void setExpiryDateFrom(java.util.Calendar _expiryDateFrom)
_expiryDateFrom - the expiryDateFrom to setpublic boolean isFillDescription()
public void setFillDescription(boolean _fillDescription)
_fillDescription - the fillDescription to setpublic int getSearchTextRule()
public void setSearchTextRule(int _searchTextRule)
_searchTextRule - the searchTextRule to setpublic java.lang.Integer getQuantityGreaterThan()
public void setQuantityGreaterThan(java.lang.Integer _quantityGreaterThan)
_quantityGreaterThan - the quantityGreaterThan to setpublic java.lang.Integer getQuantityLessThan()
public void setQuantityLessThan(java.lang.Integer _quantityLessThan)
_quantityLessThan - the quantityLessThan to setpublic java.lang.Integer getQuantityEqual()
public void setQuantityEqual(java.lang.Integer _quantityEqual)
_quantityEqual - the quantityEqual to setpublic java.util.Calendar getStartDateFrom()
public void setStartDateFrom(java.util.Calendar _startDateFrom)
_startDateFrom - the startDateFrom to setpublic java.util.Calendar getStartDateTo()
public void setStartDateTo(java.util.Calendar _startDateTo)
_startDateTo - the startDateTo to setpublic java.util.Calendar getEndDateFrom()
public void setEndDateFrom(java.util.Calendar _endDateFrom)
_endDateFrom - the endDateFrom to setpublic java.util.Calendar getEndDateTo()
public void setEndDateTo(java.util.Calendar _endDateTo)
_endDateTo - the endDateTo to setpublic java.util.Calendar getOverlapStartDate()
public void setOverlapStartDate(java.util.Calendar _overlapStartDate)
_overlapStartDate - the overlapStartDate to setpublic java.util.Calendar getOverlapEndDate()
public void setOverlapEndDate(java.util.Calendar _overlapEndDate)
_overlapEndDate - the overlapEndDate to setpublic int getProductType()
public void setProductType(int _productType)
_productType - the productType to setpublic boolean isReturnManufacturerFacets()
public void setReturnManufacturerFacets(boolean _returnManufacturerFacets)
_returnManufacturerFacets - the returnManufacturerFacets to setpublic boolean isReturnCategoryFacets()
public void setReturnCategoryFacets(boolean _returnCategoryFacets)
_returnCategoryFacets - the returnCategoryFacets to setpublic int[] getManufacturerIds()
public void setManufacturerIds(int[] _manufacturerIds)
_manufacturerIds - the manufacturerIds to setpublic int[] getCategoryIds()
public void setCategoryIds(int[] _categoryIds)
_categoryIds - the categoryIds to setpublic java.lang.Integer getOrderedGreaterThan()
public void setOrderedGreaterThan(java.lang.Integer _orderedGreaterThan)
_orderedGreaterThan - the orderedGreaterThan to setpublic java.lang.Integer getOrderedLessThan()
public void setOrderedLessThan(java.lang.Integer _orderedLessThan)
_orderedLessThan - the orderedLessThan to setpublic java.lang.Integer getOrderedEqual()
public void setOrderedEqual(java.lang.Integer _orderedEqual)
_orderedEqual - the orderedEqual to setpublic boolean isReturnCustomFacets()
public 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 | ||||||||