com.indix.query

Class SearchQuery

java.lang.Object

com.indix.query.SearchQuery

All Implemented Interfaces:

ApiParameters, BulkProductsQuery, Query

public class SearchQuery
extends Object
implements BulkProductsQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.indix.query.ApiParameters

ApiParameters.ApplyFiltersTo, ApiParameters.Availability, ApiParameters.PriceChange, ApiParameters.SelectOffersFrom, ApiParameters.SortBy

Constructor Summary

Constructors

Constructor and Description
SearchQuery()

Method Summary

Methods

Modifier and Type	Method and Description
List<org.apache.http.NameValuePair>	getParameters()
SearchQuery	withAlsoSoldAt(List<Integer> alsoSoldAt) Combined with storeId, limits results to products sold at both storeIds and alsoSoldAt storeIds.
SearchQuery	withApplyFilterTo(ApiParameters.ApplyFiltersTo applyFiltersTo) Specify the stores for which the offer level filter apply.
SearchQuery	withAvailability(ApiParameters.Availability availability) Limits results to either in-stock or out-of-stock items.
SearchQuery	withBrandId(List<Integer> brandId) Limits results to products of brands with given ids.
SearchQuery	withCategoryId(List<Integer> categoryId) Limits results to products of categories with given id.
SearchQuery	withCountryCode(String countryCode) Limits results to products of the geography with this code.
SearchQuery	withEndPrice(double endPrice) Combined with start_price, limits results to products sold by at least one store at a price between start and end
SearchQuery	withFacetBy(List<String> facetBy) Facet by values - storeId, brandId, categoryId.
SearchQuery	withLastRecordedIn(int lastRecordedIn) Limits results to products which have price recorded in the last xx days.
SearchQuery	withMpn(String mpn) Limit results to products with this MPN
SearchQuery	withOnPromotion(boolean onPromotion) Limits results to products which are on Promotion.
SearchQuery	withPageNumber(int pageNumber) Specifies the page number of the result set to return.
SearchQuery	withPageSize(int pageSize) Specifies the number of results per page.
SearchQuery	withPriceChange(ApiParameters.PriceChange priceChange) Limits results to products whose prices have been increased or decreased.
SearchQuery	withPriceHistoryAvailable(boolean priceHistoryAvailable) Limits results to product that have price history available through the products/{:id}/prices endpoint.
SearchQuery	withQ(String q) Search products against the product search term
SearchQuery	withSelectOffersFrom(ApiParameters.SelectOffersFrom selectOffersFrom) Specify the stores for which offers will be returned in the response.
SearchQuery	withSku(String sku) Limit results to products with this SKU
SearchQuery	withSortBy(ApiParameters.SortBy sortBy) Specifies the sorting strategy of the results
SearchQuery	withStartPrice(double startPrice) Combined with end_price, limits results to products sold by at least one store at a price between start and end
SearchQuery	withStoreId(List<Integer> storeId) Limits results to products sold at stores with given ids.
SearchQuery	withStoresCount(int storesCount) Limits results to products with at least a certain number of stores
SearchQuery	withUpc(String upc) Limit results to products with this UPC
SearchQuery	withUrl(String url) Search by product URL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.indix.query.Query

getParameters

Constructor Detail

SearchQuery

public SearchQuery()

Method Detail

withStoreId

public SearchQuery withStoreId(List<Integer> storeId)

Limits results to products sold at stores with given ids.

Specified by:

withStoreId in interface BulkProductsQuery

Parameters:

storeId - The list of storeIds

withAlsoSoldAt

public SearchQuery withAlsoSoldAt(List<Integer> alsoSoldAt)

Combined with storeId, limits results to products sold at both storeIds and alsoSoldAt storeIds.

Specified by:

withAlsoSoldAt in interface BulkProductsQuery

Parameters:

alsoSoldAt - The list of storeIds

withBrandId

public SearchQuery withBrandId(List<Integer> brandId)

Limits results to products of brands with given ids.

Specified by:

withBrandId in interface BulkProductsQuery

Parameters:

brandId - The list of brandIds

withCategoryId

public SearchQuery withCategoryId(List<Integer> categoryId)

Limits results to products of categories with given id.

Specified by:

withCategoryId in interface BulkProductsQuery

Parameters:

categoryId - The list of categoryIds

withStartPrice

public SearchQuery withStartPrice(double startPrice)

Combined with end_price, limits results to products sold by at least one store at a price between start and end

Specified by:

withStartPrice in interface BulkProductsQuery

withEndPrice

public SearchQuery withEndPrice(double endPrice)

Combined with start_price, limits results to products sold by at least one store at a price between start and end

Specified by:

withEndPrice in interface BulkProductsQuery

withAvailability

public SearchQuery withAvailability(ApiParameters.Availability availability)

Limits results to either in-stock or out-of-stock items.

Specified by:

withAvailability in interface BulkProductsQuery

Parameters:

availability - ApiParameters.Availability

withPriceHistoryAvailable

public SearchQuery withPriceHistoryAvailable(boolean priceHistoryAvailable)

Limits results to product that have price history available through the products/{:id}/prices endpoint. Accepted values: 'true','false'

Specified by:

withPriceHistoryAvailable in interface BulkProductsQuery

withOnPromotion

public SearchQuery withOnPromotion(boolean onPromotion)

Limits results to products which are on Promotion. Accepted values: 'true','false'

Specified by:

withOnPromotion in interface BulkProductsQuery

withLastRecordedIn

public SearchQuery withLastRecordedIn(int lastRecordedIn)

Limits results to products which have price recorded in the last xx days. Accepted Value is a non-negative integer

Specified by:

withLastRecordedIn in interface BulkProductsQuery

withStoresCount

public SearchQuery withStoresCount(int storesCount)

Limits results to products with at least a certain number of stores

Specified by:

withStoresCount in interface BulkProductsQuery

withPriceChange

public SearchQuery withPriceChange(ApiParameters.PriceChange priceChange)

Limits results to products whose prices have been increased or decreased.

Specified by:

withPriceChange in interface BulkProductsQuery

Parameters:

priceChange - ApiParameters.PriceChange

withApplyFilterTo

public SearchQuery withApplyFilterTo(ApiParameters.ApplyFiltersTo applyFiltersTo)

Specify the stores for which the offer level filter apply. Allowed values - storeId (apply filters to only stores in storeId), alsoSoldAt (apply filters to only stores in alsoSoldAt), storeIdOrAlsoSoldAt (apply filters to stores present in both storeId and alsoSoldAt), any (apply filters across all offers)

Specified by:

withApplyFilterTo in interface BulkProductsQuery

Parameters:

applyFiltersTo - ApiParameters.ApplyFiltersTo

withSelectOffersFrom

public SearchQuery withSelectOffersFrom(ApiParameters.SelectOffersFrom selectOffersFrom)

Specify the stores for which offers will be returned in the response. Allowed values - storeId (select offers matching filters from storeId), alsoSoldAt (select offers matching filters from alsoSoldAt), storeIdAndAlsoSoldAt (select offers matching filters from stores in both storeId and alsoSoldAt), all (select all offers irrespective of matching or storeId or alsoSoldAt data)

Specified by:

withSelectOffersFrom in interface BulkProductsQuery

Parameters:

selectOffersFrom - ApiParameters.SelectOffersFrom

withCountryCode

public SearchQuery withCountryCode(String countryCode)

Limits results to products of the geography with this code. Example 'US', 'GB', etc If the user doesn’t pass a value, the default option returns the US countryCode data

Specified by:

withCountryCode in interface BulkProductsQuery

Parameters:

countryCode - String value specifying countrycode

withUrl

public SearchQuery withUrl(String url)

Search by product URL

withUpc

public SearchQuery withUpc(String upc)

Limit results to products with this UPC

withMpn

public SearchQuery withMpn(String mpn)

Limit results to products with this MPN

withSku

public SearchQuery withSku(String sku)

Limit results to products with this SKU

withQ

public SearchQuery withQ(String q)

Search products against the product search term

withSortBy

public SearchQuery withSortBy(ApiParameters.SortBy sortBy)

Specifies the sorting strategy of the results

Parameters:

sortBy - - ApiParameters.SortBy

withFacetBy

public SearchQuery withFacetBy(List<String> facetBy)

Facet by values - storeId, brandId, categoryId.

withPageNumber

public SearchQuery withPageNumber(int pageNumber)

Specifies the page number of the result set to return. 10 results per page.

withPageSize

public SearchQuery withPageSize(int pageSize)

Specifies the number of results per page. Allowed values - 10, 20, 50.

getParameters

public List<org.apache.http.NameValuePair> getParameters()

Specified by:

getParameters in interface Query