com.konakart.appif
Interface ProductSearchIf

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 initialises it sets the following attributes:

• manufacturerId = ProductSearch.SEARCH_ALL
• categoryId = ProductSearch.SEARCH_ALL
• whereToSearch = 0
• searchInSubCats = true

When using the SOAP interface, this initialisation will not be done (because you will most probably be initialising an object created by a tool such as Apache Axis by reading the WSDL), so you will have to do it manually.

Method Summary

int	getCategoryId()
java.util.Calendar	getDateAddedFrom()
java.util.Calendar	getDateAddedTo()
int	getManufacturerId()
java.math.BigDecimal	getPriceFrom()
java.math.BigDecimal	getPriceTo()
java.lang.String	getSearchText()
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	isSearchInSubCats()
void	setCategoryId(int categoryId)
void	setDateAddedFrom(java.util.Calendar dateAddedFrom)
void	setDateAddedTo(java.util.Calendar dateAddedTo)
void	setManufacturerId(int manufacturerId)
void	setPriceFrom(java.math.BigDecimal priceFrom)
void	setPriceTo(java.math.BigDecimal priceTo)
void	setSearchInSubCats(boolean searchInSubCats)
void	setSearchText(java.lang.String searchText)
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

getCategoryId

int getCategoryId()

Returns:

Returns the categoryId.

setCategoryId

void setCategoryId(int categoryId)

Parameters:

categoryId - The categoryId to set.

getManufacturerId

int getManufacturerId()

Returns:

Returns the manufacturerId.

setManufacturerId

void setManufacturerId(int manufacturerId)

Parameters:

manufacturerId - The manufacturerId to set.

getPriceFrom

java.math.BigDecimal getPriceFrom()

Returns:

Returns the priceFrom.

setPriceFrom

void setPriceFrom(java.math.BigDecimal priceFrom)

Parameters:

priceFrom - The priceFrom to set.

getPriceTo

java.math.BigDecimal getPriceTo()

Returns:

Returns the priceTo.

setPriceTo

void setPriceTo(java.math.BigDecimal priceTo)

Parameters:

priceTo - The priceTo to set.

getSearchText

java.lang.String getSearchText()

Returns:

Returns the searchText.

setSearchText

void setSearchText(java.lang.String searchText)

Parameters:

searchText - The searchText to set.

getWhereToSearch

int getWhereToSearch()

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.

Returns:

Returns the whereToSearch.

setWhereToSearch

void setWhereToSearch(int whereToSearch)

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.

Parameters:

whereToSearch - The whereToSearch to set.

getDateAddedFrom

java.util.Calendar getDateAddedFrom()

Returns:

Returns the dateAddedFrom.

setDateAddedFrom

void setDateAddedFrom(java.util.Calendar dateAddedFrom)

Parameters:

dateAddedFrom - The dateAddedFrom to set.

getDateAddedTo

java.util.Calendar getDateAddedTo()

Returns:

Returns the dateAddedTo.

setDateAddedTo

void setDateAddedTo(java.util.Calendar dateAddedTo)

Parameters:

dateAddedTo - The dateAddedTo to set.

isSearchInSubCats

boolean isSearchInSubCats()

Returns:

Returns the searchInSubCats.

setSearchInSubCats

void setSearchInSubCats(boolean searchInSubCats)

Parameters:

searchInSubCats - The searchInSubCats to set.

getTagGroups

TagGroupIf[] getTagGroups()

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.

Returns:

Returns the tagGroups.

setTagGroups

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. 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.

Parameters:

tagGroups - The tagGroups to set.