Class ProductSearchModel

TopLevel.Object
- dw.catalog.SearchModel
  - dw.catalog.ProductSearchModel

The class is the central interface to a product search result and a product search refinement. It also provides utility methods to generate a search URL.

Constant	Description
CATEGORYID_PARAMETER: String = "cgid"	URL Parameter for the category ID
INVENTORY_LIST_IDS_PARAMETER: String = "ilids"	URL Parameter for the inventory list IDs
MAXIMUM_INVENTORY_LIST_IDS: Number = 10	The maximum number of inventory list IDs that can be passed to setInventoryListIDs(List)
MAXIMUM_PRODUCT_IDS: Number = 30	The maximum number of product IDs that can be passed to setProductIDs(List)
MAXIMUM_STORE_INVENTORY_FILTER_VALUES: Number = 10	The maximum number of store inventory values for a store inventory filter that can be passed to setStoreInventoryFilter(StoreInventoryFilter)
PRICE_MAX_PARAMETER: String = "pmax"	URL Parameter for the maximum price
PRICE_MIN_PARAMETER: String = "pmin"	URL Parameter for the minimum price
PRODUCTID_PARAMETER: String = "pid"	URL Parameter for the product ID
PROMOTIONID_PARAMETER: String = "pmid"	URL Parameter for the promotion ID
PROMOTION_PRODUCT_TYPE_ALL: String = "all"	constant indicating that all related products should be returned for the next product search by promotion ID
PROMOTION_PRODUCT_TYPE_BONUS: String = "bonus"	constant indicating that only bonus products should be returned for the next product search by promotion ID.
PROMOTION_PRODUCT_TYPE_DISCOUNTED: String = "discounted"	constant indicating that only discounted products should be returned for the next product search by promotion ID
PROMOTION_PRODUCT_TYPE_PARAMETER: String = "pmpt"	URL Parameter for the promotion product type
PROMOTION_PRODUCT_TYPE_QUALIFYING: String = "qualifying"	constant indicating that only qualifying products should be returned for the next product search by promotion ID
REFINE_NAME_PARAMETER_PREFIX: String = "prefn"	URL Parameter prefix for a refinement name
REFINE_VALUE_PARAMETER_PREFIX: String = "prefv"	URL Parameter prefix for a refinement value
SORTING_OPTION_PARAMETER: String = "sopt"	URL Parameter prefix for a sorting option
SORTING_RULE_PARAMETER: String = "srule"	URL Parameter prefix for a sorting rule
SORT_BY_PARAMETER_PREFIX: String = "psortb"	URL Parameter prefix for a refinement value
SORT_DIRECTION_PARAMETER_PREFIX: String = "psortd"	URL Parameter prefix for a refinement value

Property	Description
category: Category `(read-only)`	Returns the category object for the category id specified in the query.
categoryID: String	Returns the category id that was specified in the search query.
categorySearch: Boolean `(read-only)`	The method returns true, if this is a pure search for a category.
deepestCommonCategory: Category `(read-only)`	Returns the deepest common category of all products in the search result.
effectiveSortingRule: SortingRule `(read-only)`	Returns the sorting rule used to order the products in the results of this query, or `null` if no search has been executed yet.
inventoryIDs: List `(read-only)`	Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.
orderableProductsOnly: Boolean	Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made.
pageMetaTags: Array `(read-only)`	Returns all page meta tags, defined for this instance for which content can be generated.
personalizedSort: Boolean `(read-only)`	The method indicates if the search result is ordered by a personalized sorting rule.
priceMax: Number	Returns the maximum price by which the search result is refined.
priceMin: Number	Returns the minimum price by which the search result is refined.
~~productID: String~~	Returns the product id that was specified in the search query.
productIDs: List	Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.
productSearchHits: Iterator `(read-only)`	Returns the product search hits in the search result.
~~products: Iterator~~ `(read-only)`	Returns all products in the search result.
promotionID: String	Returns the promotion id that was specified in the search query or null if no promotion id set.
promotionIDs: List	Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.
promotionProductType: String	Returns the promotion product type specified in the search query.
recursiveCategorySearch: Boolean	Get the flag that determines if the category search will be recursive.
refinedByCategory: Boolean `(read-only)`	The method returns true, if the search is refined by a category.
refinedByPrice: Boolean `(read-only)`	Identifies if this search has been refined by price.
refinedByPromotion: Boolean `(read-only)`	Identifies if this search has been refined by promotion.
refinedCategorySearch: Boolean `(read-only)`	Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.
refinementCategory: Category	Returns the category used to determine possible refinements for the search.
refinements: ProductSearchRefinements `(read-only)`	Returns the ProductSearchRefinements associated with this search and filtered by session currency.
searchPhraseSuggestions: SearchPhraseSuggestions `(read-only)`	Returns search phrase suggestions for the current search phrase.
searchableImageUploadURL: String `(read-only)`	This method returns the URL of the endpoint where the merchants should upload their image for visual search.
sortingRule: SortingRule	Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or `null` if no rule has been explicitly set.
storeInventoryFilter: StoreInventoryFilter	Returns the StoreInventoryFilter, which was specified for this search.
~~suggestedSearchPhrase: String~~ `(read-only)`	Returns the suggested search phrase with the highest accuracy provided for the current search phrase.
~~suggestedSearchPhrases: List~~ `(read-only)`	Returns a list with up to 5 suggested search phrases provided for the current search phrase.
trackingEmptySearchesEnabled: Boolean `(read-only)`	The method indicates if no-hits search should be tracked for predictive intelligence use.
visualSearch: Boolean `(read-only)`	The method returns true, if this is a visual search.

Constructor	Description
ProductSearchModel()	Constructs a new ProductSearchModel.

Method	Description
addHitTypeRefinement(String...)	Set the only search hit types to be included from the search.
excludeHitType(String...)	Set the search hit types to be excluded from the search.
getCategory()	Returns the category object for the category id specified in the query.
getCategoryID()	Returns the category id that was specified in the search query.
getDeepestCommonCategory()	Returns the deepest common category of all products in the search result.
getEffectiveSortingRule()	Returns the sorting rule used to order the products in the results of this query, or `null` if no search has been executed yet.
getInventoryIDs()	Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.
getOrderableProductsOnly()	Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made.
getPageMetaTag(String)	Returns the page meta tag for the specified id.
getPageMetaTags()	Returns all page meta tags, defined for this instance for which content can be generated.
getPriceMax()	Returns the maximum price by which the search result is refined.
getPriceMin()	Returns the minimum price by which the search result is refined.
~~getProductID()~~	Returns the product id that was specified in the search query.
getProductIDs()	Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.
getProductSearchHit(Product)	Returns the underlying ProductSearchHit for a product, or null if no ProductSearchHit found for this product.
getProductSearchHits()	Returns the product search hits in the search result.
~~getProducts()~~	Returns all products in the search result.
getPromotionID()	Returns the promotion id that was specified in the search query or null if no promotion id set.
getPromotionIDs()	Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.
getPromotionProductType()	Returns the promotion product type specified in the search query.
getRefinementCategory()	Returns the category used to determine possible refinements for the search.
getRefinements()	Returns the ProductSearchRefinements associated with this search and filtered by session currency.
getSearchPhraseSuggestions()	Returns search phrase suggestions for the current search phrase.
getSearchableImageUploadURL()	This method returns the URL of the endpoint where the merchants should upload their image for visual search.
getSortingRule()	Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or `null` if no rule has been explicitly set.
getStoreInventoryFilter()	Returns the StoreInventoryFilter, which was specified for this search.
~~getSuggestedSearchPhrase()~~	Returns the suggested search phrase with the highest accuracy provided for the current search phrase.
~~getSuggestedSearchPhrases()~~	Returns a list with up to 5 suggested search phrases provided for the current search phrase.
isCategorySearch()	The method returns true, if this is a pure search for a category.
isPersonalizedSort()	The method indicates if the search result is ordered by a personalized sorting rule.
isRecursiveCategorySearch()	Get the flag that determines if the category search will be recursive.
isRefinedByCategory()	The method returns true, if the search is refined by a category.
isRefinedByPrice()	Identifies if this search has been refined by price.
isRefinedByPriceRange(Number, Number)	Identifies if this search has been refined by the given price range.
isRefinedByPromotion()	Identifies if this search has been refined by promotion.
isRefinedByPromotion(String)	Identifies if this search has been refined by a given promotion.
isRefinedCategorySearch()	Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.
isTrackingEmptySearchesEnabled()	The method indicates if no-hits search should be tracked for predictive intelligence use.
isVisualSearch()	The method returns true, if this is a visual search.
search()	Execute the search based on the configured search term, category and filter conditions (price, attribute, promotion, product type) and return the execution status.
setCategoryID(String)	Specifies the category id used for the search query.
setEnableTrackingEmptySearches(Boolean)	Set a flag indicating whether no-hits search should be tracked for predictive intelligence use.
setInventoryListIDs(List)	Specifies multiple inventory list IDs used for the search query.
setOrderableProductsOnly(Boolean)	Set a flag indicating whether unorderable products should be excluded when the next call to getProducts() is made.
setPriceMax(Number)	Sets the maximum price by which the search result is to be refined.
setPriceMin(Number)	Sets the minimum price by which the search result is to be refined.
~~setProductID(String)~~	Specifies the product id used for the search query.
setProductIDs(List)	Specifies multiple product IDs used for the search query.
setPromotionID(String)	Specifies the promotion id used for the search query.
setPromotionIDs(List)	Specifies multiple promotion id's used for the search query.
setPromotionProductType(String)	Specifies the promotion product type used for the search query.
setRecursiveCategorySearch(Boolean)	Set a flag to indicate if the search in category should be recursive.
setRefinementCategory(Category)	Sets an explicit category to be used when determining refinements.
setSearchableImageID(String)	An image ID can be retrieved by uploading an image with a multipart/form-data POST request to 'https://api.cquotient.com/v3/image/search/upload/{siteID}'.
~~setSortingCondition(String, Number)~~	Sets or removes a sorting condition for the specified attribute.
setSortingOption(SortingOption)	Sets the sorting option to be used to order the products in the results of this query.
setSortingRule(SortingRule)	Sets the sorting rule to be used to order the products in the results of this query.
setStoreInventoryFilter(StoreInventoryFilter)	Filters the search result by one or more inventory list IDs provided by the class StoreInventoryFilter which supports a semantic URL parameter like zip, city, store ...
static urlForCategory(URL, String)	Constructs a URL that you can use to execute a query for a specific Category.
static urlForCategory(String, String)	Constructs a URL that you can use to execute a query for a specific Category.
static urlForProduct(URL, String, String)	Constructs a URL that you can use to execute a query for a specific Product.
static urlForProduct(String, String, String)	Constructs a URL that you can use to execute a query for a specific Product.
static urlForRefine(URL, String, String)	Constructs a URL that you can use to execute a query for a specific attribute name-value pair.
static urlForRefine(String, String, String)	Constructs a URL that you can use to execute a query for a specific attribute name-value pair.
urlRefineCategory(URL, String)	Constructs a URL that you can use to re-execute the query with a category refinement.
urlRefineCategory(String, String)	Constructs a URL that you can use to re-execute the query with a category refinement.
urlRefinePrice(URL, Number, Number)	Constructs a URL that you can use to re-execute the query with an additional price filter.
urlRefinePrice(String, Number, Number)	Constructs a URL that you can use to re-execute the query with an additional price filter.
urlRefinePromotion(URL, String)	Constructs a URL that you can use to re-execute the query with a promotion refinement.
urlRefinePromotion(String, String)	Constructs a URL that you can use to re-execute the query with a promotion refinement.
urlRelaxCategory(URL)	Constructs a URL that you can use to re-execute the query without any category refinement.
urlRelaxCategory(String)	Constructs a URL that you can use to re-execute the query without any category refinement.
urlRelaxPrice(URL)	Constructs a URL that you can use to would re-execute the query with no price filter.
urlRelaxPrice(String)	Constructs a URL that you can use to re-execute the query with no price filter.
urlRelaxPromotion(URL)	Constructs a URL that you can use to re-execute the query without any promotion refinement.
urlRelaxPromotion(String)	Constructs a URL that you can use to re-execute the query without any promotion refinement.
urlSortingOption(URL, SortingOption)	Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option.
urlSortingOption(String, SortingOption)	Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option.
urlSortingRule(URL, SortingRule)	Constructs a URL that you can use to re-execute the query but sort the results by the given rule.
urlSortingRule(String, SortingRule)	Constructs a URL that you can use to re-execute the query but sort the results by the given rule.

addRefinementValues, canRelax, getCount, getRefinementMaxValue, getRefinementMinValue, getRefinementValue, getRefinementValues, getSearchPhrase, getSearchRedirect, getSortingCondition, isEmptyQuery, isRefinedByAttribute, isRefinedByAttribute, isRefinedByAttributeValue, isRefinedSearch, isRefinementByValueRange, isRefinementByValueRange, removeRefinementValues, search, setRefinementValueRange, setRefinementValues, setSearchPhrase, setSortingCondition, url, url, urlDefaultSort, urlDefaultSort, urlRefineAttribute, urlRefineAttribute, urlRefineAttributeValue, urlRefineAttributeValue, urlRefineAttributeValueRange, urlRelaxAttribute, urlRelaxAttribute, urlRelaxAttributeValue, urlRelaxAttributeValue, urlSort, urlSort

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

CATEGORYID_PARAMETER: String = "cgid": URL Parameter for the category ID

INVENTORY_LIST_IDS_PARAMETER: String = "ilids": URL Parameter for the inventory list IDs

MAXIMUM_INVENTORY_LIST_IDS: Number = 10: The maximum number of inventory list IDs that can be passed to setInventoryListIDs(List)

MAXIMUM_PRODUCT_IDS: Number = 30: The maximum number of product IDs that can be passed to setProductIDs(List)

MAXIMUM_STORE_INVENTORY_FILTER_VALUES: Number = 10: The maximum number of store inventory values for a store inventory filter that can be passed to setStoreInventoryFilter(StoreInventoryFilter)

PRICE_MAX_PARAMETER: String = "pmax": URL Parameter for the maximum price

PRICE_MIN_PARAMETER: String = "pmin": URL Parameter for the minimum price

PRODUCTID_PARAMETER: String = "pid": URL Parameter for the product ID

PROMOTIONID_PARAMETER: String = "pmid": URL Parameter for the promotion ID

PROMOTION_PRODUCT_TYPE_ALL: String = "all": constant indicating that all related products should be returned for the next product search by promotion ID

PROMOTION_PRODUCT_TYPE_BONUS: String = "bonus": constant indicating that only bonus products should be returned for the next product search by promotion ID. This constant should be set using setPromotionProductType(String) when using the search model to find the available list of bonus products for a Choice of Bonus Product (Rule) promotion, along with setPromotionID(String).

PROMOTION_PRODUCT_TYPE_DISCOUNTED: String = "discounted": constant indicating that only discounted products should be returned for the next product search by promotion ID

PROMOTION_PRODUCT_TYPE_PARAMETER: String = "pmpt": URL Parameter for the promotion product type

PROMOTION_PRODUCT_TYPE_QUALIFYING: String = "qualifying": constant indicating that only qualifying products should be returned for the next product search by promotion ID

REFINE_NAME_PARAMETER_PREFIX: String = "prefn": URL Parameter prefix for a refinement name

REFINE_VALUE_PARAMETER_PREFIX: String = "prefv": URL Parameter prefix for a refinement value

SORTING_OPTION_PARAMETER: String = "sopt": URL Parameter prefix for a sorting option

SORTING_RULE_PARAMETER: String = "srule": URL Parameter prefix for a sorting rule

SORT_BY_PARAMETER_PREFIX: String = "psortb": URL Parameter prefix for a refinement value

SORT_DIRECTION_PARAMETER_PREFIX: String = "psortd": URL Parameter prefix for a refinement value

category: Category (read-only): Returns the category object for the category id specified in the query. If a category with that id doesn't exist or if the category is offline this method returns null.

categoryID: String: Returns the category id that was specified in the search query.

categorySearch: Boolean (read-only): The method returns true, if this is a pure search for a category. The method checks, that a category ID is specified and no search phrase is specified.

deepestCommonCategory: Category (read-only): Returns the deepest common category of all products in the search result. In case of an empty search result the method returns the root category.

effectiveSortingRule: SortingRule (read-only)

Returns the sorting rule used to order the products in the results of this query, or null if no search has been executed yet.

In contrast to getSortingRule(), this method respects explicit sorting rules and sorting options and rules determined implicitly based on the refinement category, keyword sorting rule assignment, etc.

inventoryIDs: List (read-only)

Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.

orderableProductsOnly: Boolean: Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. If this value has not been previously set, then the value returned will be based on the value of the search preference.

pageMetaTags: Array (read-only)

Returns all page meta tags, defined for this instance for which content can be generated.

The meta tag content is generated based on the product listing page meta tag context and rules. The rules are obtained from the current category context or inherited from the parent category, up to the root category.

personalizedSort: Boolean (read-only): The method indicates if the search result is ordered by a personalized sorting rule.

priceMax: Number: Returns the maximum price by which the search result is refined.

priceMin: Number: Returns the minimum price by which the search result is refined.

~~productID: String~~

Returns the product id that was specified in the search query.

Deprecated:

Please use getProductIDs() instead

productIDs: List: Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.

productSearchHits: Iterator (read-only)

Returns the product search hits in the search result.

Note that method does also return search hits representing products that were removed or went offline since the last index update, i.e. you must implement appropriate checks before accessing the product related to the search hit instance (see ProductSearchHit.getProduct())

See Also:

getProducts()

~~products: Iterator~~ (read-only)

Returns all products in the search result.

Note that products that were removed or went offline since the last index update are not included in the returned set.

See Also:

getProductSearchHits()

Deprecated:

This method should not be used because loading Products for each result of a product search is extremely expensive performance-wise. Please use getProductSearchHits() to iterate ProductSearchHits instead.

promotionID: String: Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple promotion id's specified the method returns only the first id. See setPromotionIDs(List) and getPromotionIDs().

promotionIDs: List: Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.

promotionProductType: String: Returns the promotion product type specified in the search query.

recursiveCategorySearch: Boolean: Get the flag that determines if the category search will be recursive.

refinedByCategory: Boolean (read-only): The method returns true, if the search is refined by a category. The method checks, that a category ID is specified.

refinedByPrice: Boolean (read-only): Identifies if this search has been refined by price.

refinedByPromotion: Boolean (read-only): Identifies if this search has been refined by promotion.

refinedCategorySearch: Boolean (read-only): Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.

refinementCategory: Category: Returns the category used to determine possible refinements for the search. If an explicit category was set for this purpose using setRefinementCategory(Category), it is returned. Otherwise, the deepest common category of all search results will be returned.

refinements: ProductSearchRefinements (read-only): Returns the ProductSearchRefinements associated with this search and filtered by session currency. If an explicit category was set for this purpose using setRefinementCategory(Category), it will be used to determine the refinements. Otherwise, the refinements are determined based on the deepest common category of all products in the search result. Hint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory(Category) to avoid unnecessary calculation of the deepest common category.

searchPhraseSuggestions: SearchPhraseSuggestions (read-only): Returns search phrase suggestions for the current search phrase. Search phrase suggestions may contain alternative search phrases as well as lists of corrected and completed search terms.

searchableImageUploadURL: String (read-only): This method returns the URL of the endpoint where the merchants should upload their image for visual search.

sortingRule: SortingRule

Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or null if no rule has been explicitly set.

This method does not return the sorting rule that will be used implicitly based on the context of the search, such as the refinement category.

storeInventoryFilter: StoreInventoryFilter

Returns the StoreInventoryFilter, which was specified for this search.

~~suggestedSearchPhrase: String~~ (read-only)

Returns the suggested search phrase with the highest accuracy provided for the current search phrase.

Deprecated:

Please use getSearchPhraseSuggestions() instead

~~suggestedSearchPhrases: List~~ (read-only)

Returns a list with up to 5 suggested search phrases provided for the current search phrase. It is possible that less than 5 suggestions or even no suggestions are returned.

Deprecated:

Please use getSearchPhraseSuggestions() instead

trackingEmptySearchesEnabled: Boolean (read-only): The method indicates if no-hits search should be tracked for predictive intelligence use.

visualSearch: Boolean (read-only): The method returns true, if this is a visual search. The method checks that a image UUID is specified.

ProductSearchModel(): Constructs a new ProductSearchModel.

addHitTypeRefinement(types: String...): void

Set the only search hit types to be included from the search. Values accepted are the 'hit type' constants exposed in the ProductSearchHit class. Overwrites any hit type refinements set from prior calls to addHitTypeRefinement(String...) or excludeHitType(String...).

Parameters:

types - to be included.

excludeHitType(types: String...): void

Set the search hit types to be excluded from the search. Values accepted are the 'hit type' constants exposed in the ProductSearchHit class. Overwrites any hit type refinements set from prior calls to addHitTypeRefinement(String...) or excludeHitType(String...).

Parameters:

types - to be excluded.

getCategory(): Category

Returns the category object for the category id specified in the query. If a category with that id doesn't exist or if the category is offline this method returns null.

Returns:

the category object for the category id specified in the query.

getCategoryID(): String

Returns the category id that was specified in the search query.

Returns:

the category id that was specified in the search query.

getDeepestCommonCategory(): Category

Returns the deepest common category of all products in the search result. In case of an empty search result the method returns the root category.

Returns:

the deepest common category of all products in the search result of this search model or root for an empty search result.

getEffectiveSortingRule(): SortingRule

Returns the sorting rule used to order the products in the results of this query, or null if no search has been executed yet.

Returns:

a SortingRule or null.

getInventoryIDs(): List

Returns a list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.

Returns:

the list of inventory IDs that were specified in the search query or an empty list if no inventory ID set.

getOrderableProductsOnly(): Boolean

Get the flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. If this value has not been previously set, then the value returned will be based on the value of the search preference.

Returns:

true if unorderable products should be excluded from product search results, false otherwise.

getPageMetaTag(id: String): PageMetaTag

Returns the page meta tag for the specified id.

The meta tag content is generated based on the product listing page meta tag context and rule. The rule is obtained from the current category context or inherited from the parent category, up to the root category.

Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the current context, or if the rule resolves to an empty string.

Parameters:

id - the ID to get the page meta tag for

Returns:

page meta tag containing content generated based on rules

getPageMetaTags(): Array

Returns all page meta tags, defined for this instance for which content can be generated.

Returns:

page meta tags defined for this instance, containing content generated based on rules

getPriceMax(): Number

Returns the maximum price by which the search result is refined.

Returns:

the maximum price by which the search result is refined.

getPriceMin(): Number

Returns the minimum price by which the search result is refined.

Returns:

the minimum price by which the search result is refined.

~~getProductID(): String~~

Returns the product id that was specified in the search query.

Returns:

the product id that was specified in the search.

Deprecated:

Please use getProductIDs() instead

getProductIDs(): List

Returns a list of product IDs that were specified in the search query or an empty list if no product ID set.

Returns:

the list of product IDs that were specified in the search query or an empty list if no product ID set.

getProductSearchHit(product: Product): ProductSearchHit

Returns the underlying ProductSearchHit for a product, or null if no ProductSearchHit found for this product.

Parameters:

product - the product to find the underlying ProductSearchHit

Returns:

the underlying ProductSearchHit for a product, or null if no ProductSearchHit found for this product.

getProductSearchHits(): Iterator

Returns the product search hits in the search result.

Returns:

Products hits in search result

See Also:

getProducts()

~~getProducts(): Iterator~~

Returns all products in the search result.

Note that products that were removed or went offline since the last index update are not included in the returned set.

Returns:

Products in search result

See Also:

getProductSearchHits()

Deprecated:

getPromotionID(): String

Returns the promotion id that was specified in the search query or null if no promotion id set. If multiple promotion id's specified the method returns only the first id. See setPromotionIDs(List) and getPromotionIDs().

Returns:

the promotion id that was specified in the search query or null if no promotion id set.

getPromotionIDs(): List

Returns a list of promotion id's that were specified in the search query or an empty list if no promotion id set.

Returns:

the list of promotion id's that was specified in the search query or an empty list if no promotion id set.

getPromotionProductType(): String

Returns the promotion product type specified in the search query.

Returns:

the promotion product type that was specified in the search query.

getRefinementCategory(): Category

Returns the category used to determine possible refinements for the search. If an explicit category was set for this purpose using setRefinementCategory(Category), it is returned. Otherwise, the deepest common category of all search results will be returned.

Returns:

the category used to determine refinements.

getRefinements(): ProductSearchRefinements

Returns the ProductSearchRefinements associated with this search and filtered by session currency. If an explicit category was set for this purpose using setRefinementCategory(Category), it will be used to determine the refinements. Otherwise, the refinements are determined based on the deepest common category of all products in the search result. Hint: If you want to use the same refinements for all searches, consider defining them in one category (usually root) and using setRefinementCategory(Category) to avoid unnecessary calculation of the deepest common category.

Returns:

the ProductSearchRefinements associated with this search.

getSearchPhraseSuggestions(): SearchPhraseSuggestions

Returns search phrase suggestions for the current search phrase. Search phrase suggestions may contain alternative search phrases as well as lists of corrected and completed search terms.

Returns:

search phrase suggestions for the current search phrase

getSearchableImageUploadURL(): String

This method returns the URL of the endpoint where the merchants should upload their image for visual search.

Returns:

returns the URL where the merchants should upload their image.

Throws:

RuntimeException -

getSortingRule(): SortingRule

Returns the sorting rule explicitly set on this model to be used to order the products in the results of this query, or null if no rule has been explicitly set.

This method does not return the sorting rule that will be used implicitly based on the context of the search, such as the refinement category.

Returns:

a SortingRule or null.

getStoreInventoryFilter(): StoreInventoryFilter

Returns the StoreInventoryFilter, which was specified for this search.

Returns:

the StoreInventoryFilter, which was specified for this search.

~~getSuggestedSearchPhrase(): String~~

Returns the suggested search phrase with the highest accuracy provided for the current search phrase.

Returns:

the suggested search phrase.

Deprecated:

Please use getSearchPhraseSuggestions() instead

~~getSuggestedSearchPhrases(): List~~

Returns a list with up to 5 suggested search phrases provided for the current search phrase. It is possible that less than 5 suggestions or even no suggestions are returned.

Returns:

a list containing the suggested search phrases.

Deprecated:

Please use getSearchPhraseSuggestions() instead

isCategorySearch(): Boolean

The method returns true, if this is a pure search for a category. The method checks, that a category ID is specified and no search phrase is specified.

Returns:

True if this is a category search

isPersonalizedSort(): Boolean

The method indicates if the search result is ordered by a personalized sorting rule.

Returns:

true if search result is ordered by a personalized sorting rule, otherwise false.

isRecursiveCategorySearch(): Boolean

Get the flag that determines if the category search will be recursive.

Returns:

true if the category search will be recursive, false otherwise

isRefinedByCategory(): Boolean

The method returns true, if the search is refined by a category. The method checks, that a category ID is specified.

Returns:

true, if the search is refined by a category, false otherwise.

isRefinedByPrice(): Boolean

Identifies if this search has been refined by price.

Returns:

True if the search is refined by price, false otherwise.

isRefinedByPriceRange(priceMin: Number, priceMax: Number): Boolean

Identifies if this search has been refined by the given price range. Either range parameters may be null to represent open ranges.

Parameters:

priceMin - The lower bound of the price range.
priceMax - The upper bound of the price range.

Returns:

True if the search is refinemd on the given price range, false otherwise.

isRefinedByPromotion(): Boolean

Identifies if this search has been refined by promotion.

Returns:

True if the search is refined by promotion, false otherwise.

isRefinedByPromotion(promotionID: String): Boolean

Identifies if this search has been refined by a given promotion.

Parameters:

promotionID - the ID of the promotion to check

Returns:

True if the search is refined by the given promotionID, false otherwise.

isRefinedCategorySearch(): Boolean

Identifies if this is a category search and is refined with further criteria, like a brand refinement or an attribute refinement.

Returns:

true if this is a category search and is refined with further criteria, false otherwise.

isTrackingEmptySearchesEnabled(): Boolean

The method indicates if no-hits search should be tracked for predictive intelligence use.

Returns:

true, if no-hits search should be tracked, otherwise false.

isVisualSearch(): Boolean

The method returns true, if this is a visual search. The method checks that a image UUID is specified.

Returns:

True if this is a visual search

search(): SearchStatus

Execute the search based on the configured search term, category and filter conditions (price, attribute, promotion, product type) and return the execution status. The execution of an empty ProductSearchModel without any search term or filter criteria will not be supported and the search status SearchStatus.EMPTY_QUERY will be returned. A usage of the internal category id 'root' as category filter is not recommended, could cause performance issues and will be potentially deprecated in a future release. A successful execution will be indicated by SearchStatus.SUCCESSFUL or SearchStatus.LIMITED. For other possible search statuses see SearchStatus. The sorted and grouped search result of a successful execution can be fetched via getProductSearchHits() and the refinement options based on the search result can be obtained via getRefinements() and SearchModel.getRefinementValues(String).

Returns:

the searchStatus object with search status code and description of search result.

setCategoryID(categoryID: String): void

Specifies the category id used for the search query.

Parameters:

categoryID - the category id for the search query.

setEnableTrackingEmptySearches(trackingEmptySearches: Boolean): void

Set a flag indicating whether no-hits search should be tracked for predictive intelligence use.

Parameters:

trackingEmptySearches - true, no-hits search should be tracked, false, otherwise.

setInventoryListIDs(inventoryListIDs: List): void

Specifies multiple inventory list IDs used for the search query. The method supports up to MAXIMUM_INVENTORY_LIST_IDS inventory IDs. If more than MAXIMUM_INVENTORY_LIST_IDS inventory IDs used the method throws an IllegalArgumentException.

Parameters:

inventoryListIDs - the inventory IDs for the search query.

Throws:

IllegalArgumentException - if more than MAXIMUM_INVENTORY_LIST_IDS inventory IDs used

setOrderableProductsOnly(orderableOnly: Boolean): void

Set a flag indicating whether unorderable products should be excluded when the next call to getProducts() is made. This method overrides the default behavior which is controlled by the search preference.

Parameters:

orderableOnly - true if unorderable products should be excluded from product search results, false otherwise.

setPriceMax(priceMax: Number): void

Sets the maximum price by which the search result is to be refined.

Parameters:

priceMax - sets the maximum price by which the search result is to be refined.

setPriceMin(priceMin: Number): void

Sets the minimum price by which the search result is to be refined.

Parameters:

priceMin - the minimum price by which the search result is to be refined.

~~setProductID(productID: String): void~~

Specifies the product id used for the search query.

Parameters:

productID - the product id for the search query.

Deprecated:

Please use setProductIDs(List) instead

setProductIDs(productIDs: List): void

Specifies multiple product IDs used for the search query. The specified product IDs include, but not limited to, variant product IDs, product master IDs, variation group IDs, product set IDs, or product bundle IDs. For example, this API could be used in high-traffic pages where developers need to be able to filter quickly for only available child products of a specified master product, instead of looping through all variants of a set products and checking their availabilities. The method supports up to MAXIMUM_PRODUCT_IDS product IDs. If more than MAXIMUM_PRODUCT_IDS products IDs are passed, the method throws an IllegalArgumentException.

Parameters:

productIDs - the product IDs for the search query.

Throws:

IllegalArgumentException - if more than MAXIMUM_PRODUCT_IDS product IDs used

setPromotionID(promotionID: String): void

Specifies the promotion id used for the search query.

Parameters:

promotionID - the promotion id for the search query.

setPromotionIDs(promotionIDs: List): void

Specifies multiple promotion id's used for the search query. The method supports up to 30 promotion id's. If more than 30 promotion id's used the method throws an IllegalArgumentException.

Parameters:

promotionIDs - the promotion ids for the search query.

Throws:

IllegalArgumentException - if more than 30 promotion id's used

setPromotionProductType(promotionProductType: String): void

Specifies the promotion product type used for the search query. This value is only relevant for searches by promotion ID.

Parameters:

promotionProductType - The type of product to filter by when searching by promotion ID. Allowed values are PROMOTION_PRODUCT_TYPE_ALL, PROMOTION_PRODUCT_TYPE_BONUS, PROMOTION_PRODUCT_TYPE_QUALIFYING, and PROMOTION_PRODUCT_TYPE_DISCOUNTED. If null is passed, or an invalid value is passed, the search will use PROMOTION_PRODUCT_TYPE_ALL.

setRecursiveCategorySearch(recurse: Boolean): void

Set a flag to indicate if the search in category should be recursive.

Parameters:

recurse - recurse the category in the search

setRefinementCategory(refinementCategory: Category): void

Sets an explicit category to be used when determining refinements. If this is not done, they will be determined based on the deepest common category of all search results. The explicit category must be in the site's storefront catalog, otherwise the method fails with an IllegalArgumentException.

Parameters:

refinementCategory - the category used to determine the applicable refinements.

Throws:

IllegalArgumentException - if the refinement category does not reside in the storefront catalog

setSearchableImageID(imageID: String): void

An image ID can be retrieved by uploading an image with a multipart/form-data POST request to 'https://api.cquotient.com/v3/image/search/upload/{siteID}'. This method sets product IDs retrieved from the image ID to the ProductSearchModel. If using setProductIDs(List) in addition to this method, the ProductSearchModel will take the intersection of these sets of product IDs. If the image ID provided is invalid or expired, product IDs will not be set onto the product search model.

Parameters:

imageID - the image ID for the visual search query.

Throws:

RuntimeException - if product IDs for the provided image could not be set.

~~setSortingCondition(attributeID: String, direction: Number): void~~

Sets or removes a sorting condition for the specified attribute. Specify either SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a sorting condition. Specify SORT_DIRECTION_NONE to remove a sorting condition from the attribute.

Parameters:

attributeID - the attribute ID
direction - SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING or SORT_DIRECTION_NONE

Deprecated:

This method is subject to removal. Use setSortingRule(SortingRule) instead.

setSortingOption(option: SortingOption): void

Sets the sorting option to be used to order the products in the results of this query. If a sorting rule is also set, the sorting option is ignored.

Parameters:

option - the SortingOption to use to sort the products

setSortingRule(rule: SortingRule): void

Sets the sorting rule to be used to order the products in the results of this query. Setting the rule in this way overrides the default behavior of choosing the sorting rule based on the context of the search, such as the refinement category.

Parameters:

rule - the SortingRule to use to sort the products

setStoreInventoryFilter(storeInventoryFilter: StoreInventoryFilter): void

Filters the search result by one or more inventory list IDs provided by the class StoreInventoryFilter which supports a semantic URL parameter like zip, city, store ... and a list of StoreInventoryFilterValue which maps the semantic inventory list id value like Burlington, Boston, ... to a real inventory list id like 'Burlington -> inventory1', 'Boston -> inventory2'. The search will filter the result by the real inventory list id(s) but will use the semantic URL parameter and semantic inventory list id values for URL generation via all URLRefine and URLRelax methods e.g. for urlRefineCategory(URL, String), urlRelaxPrice(URL), SearchModel.urlRefineAttribute(String, String, String).

Example custom URL: city=Burlington|Boston

Parameters:

storeInventoryFilter - The StoreInventoryFilter instance to filter the search result by one or more inventory IDs with semantic key and semantic value support.

Throws:

IllegalArgumentException - if more than MAXIMUM_STORE_INVENTORY_FILTER_VALUES filter values used

static urlForCategory(url: URL, cgid: String): URL

Constructs a URL that you can use to execute a query for a specific Category. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the URL to use to generate the new URL.
cgid - the category ID.

Returns:

the new URL.

static urlForCategory(action: String, cgid: String): URL

Constructs a URL that you can use to execute a query for a specific Category.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - pipeline action, e.g. 'Search-Show'.
cgid - the category ID.

Returns:

the new URL.

static urlForProduct(url: URL, cgid: String, pid: String): URL

Constructs a URL that you can use to execute a query for a specific Product. The passed url can be either a full url or just the name for a pipeline. In the later case a relative URL is created.

Parameters:

url - the URL to use to generate the new URL.
cgid - the category id or null if product is not in category context.
pid - the product id.

Returns:

the new URL.

static urlForProduct(action: String, cgid: String, pid: String): URL

Constructs a URL that you can use to execute a query for a specific Product. The passed action is used to build an initial url. All search specific attributes are appended.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - pipeline action, e.g. 'Search-Show'.
cgid - the category id or null if product is not in category context.
pid - the product id.

Returns:

the new URL.

static urlForRefine(url: URL, attributeID: String, value: String): URL

Constructs a URL that you can use to execute a query for a specific attribute name-value pair. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the URL to use to generate the new URL.
attributeID - the attribute ID for the refinement.
value - the attribute value for the refinement.

Returns:

the new URL.

static urlForRefine(action: String, attributeID: String, value: String): URL

Constructs a URL that you can use to execute a query for a specific attribute name-value pair.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - pipeline action, e.g. 'Search-Show'.
attributeID - the attribute ID for the refinement.
value - the attribute value for the refinement.

Returns:

the new URL.

urlRefineCategory(url: URL, refineCategoryID: String): URL

Constructs a URL that you can use to re-execute the query with a category refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.
refineCategoryID - the ID of the category.

Returns:

the new URL.

urlRefineCategory(action: String, refineCategoryID: String): URL

Constructs a URL that you can use to re-execute the query with a category refinement.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'
refineCategoryID - the ID of the category.

Returns:

the new URL.

urlRefinePrice(url: URL, min: Number, max: Number): URL

Constructs a URL that you can use to re-execute the query with an additional price filter. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the URL to use to generate the new URL.
min - the minimum price.
max - the maximum price.

Returns:

the new URL.

urlRefinePrice(action: String, min: Number, max: Number): URL

Constructs a URL that you can use to re-execute the query with an additional price filter.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'.
min - the minimum price.
max - the maximum price.

Returns:

the new URL.

urlRefinePromotion(url: URL, refinePromotionID: String): URL

Constructs a URL that you can use to re-execute the query with a promotion refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.
refinePromotionID - the ID of the promotion.

Returns:

the new URL.

urlRefinePromotion(action: String, refinePromotionID: String): URL

Constructs a URL that you can use to re-execute the query with a promotion refinement. The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'
refinePromotionID - the ID of the promotion.

Returns:

the new URL.

urlRelaxCategory(url: URL): URL

Constructs a URL that you can use to re-execute the query without any category refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.

Returns:

the new URL.

urlRelaxCategory(action: String): URL

Constructs a URL that you can use to re-execute the query without any category refinement.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'.

Returns:

the new URL.

urlRelaxPrice(url: URL): URL

Constructs a URL that you can use to would re-execute the query with no price filter. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.

Returns:

the new URL.

urlRelaxPrice(action: String): URL

Constructs a URL that you can use to re-execute the query with no price filter.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'

Returns:

the new URL.

urlRelaxPromotion(url: URL): URL

Constructs a URL that you can use to re-execute the query without any promotion refinement. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.

Returns:

the new URL.

urlRelaxPromotion(action: String): URL

Constructs a URL that you can use to re-execute the query without any promotion refinement. The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'.

Returns:

the new URL.

urlSortingOption(url: URL, option: SortingOption): URL

Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.
option - sorting option

Returns:

the new URL.

urlSortingOption(action: String, option: SortingOption): URL

Constructs a URL that you can use to re-execute the query but sort the results by the given storefront sorting option.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'.
option - sorting option

Returns:

the new URL.

urlSortingRule(url: URL, rule: SortingRule): URL

Constructs a URL that you can use to re-execute the query but sort the results by the given rule. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the existing URL to use to create the new URL.
rule - sorting rule

Returns:

the new URL.

urlSortingRule(action: String, rule: SortingRule): URL

Constructs a URL that you can use to re-execute the query but sort the results by the given rule.

The generated URL will be an absolute URL which uses the protocol of the current request.

Parameters:

action - the pipeline action, e.g. 'Search-Show'.
rule - sorting rule

Returns:

the new URL.