Class CategorySuggestions

dw.suggest

Object

dw.suggest.Suggestions

dw.suggest.CategorySuggestions

The category suggestion container provides access to categories found using the suggested terms as search criteria. The method getSuggestedCategories() can be used to get the list of found categories.

Furthermore the list of suggested terms, after processing the original user input search query, is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.

suggestedCategories : Iterator (Read Only)

This method returns a list of categories which were found using the suggested terms as search criteria. The category lookup is being executed in the current catalog and locale.

This class does not have a constructor, so you cannot create it directly.

getSuggestedCategories() : Iterator

This method returns a list of categories which were found using the suggested terms as search criteria.

Methods inherited from class Suggestions

getSearchPhraseSuggestions, getSuggestedPhrases, getSuggestedTerms, hasSuggestedPhrases, hasSuggestedTerms, hasSuggestions

Methods inherited from class Object

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

getSuggestedCategories

getSuggestedCategories() : Iterator

This method returns a list of categories which were found using the suggested terms as search criteria. The category lookup is being executed in the current catalog and locale.

Returns:

a iterator containing a SuggestedCategory instance for each found category, the iterator might be empty