Script: Class dw.catalog.SearchModel

Class SearchModel

Common search model base class.

All Known Subclasses

ContentSearchModel, ProductSearchModel

Constants

SEARCH_PHRASE_PARAMETER : String = "q"

URL Parameter for the Search Phrase

SORT_DIRECTION_ASCENDING : Number=1

Sorting parameter ASCENDING

SORT_DIRECTION_DESCENDING : Number=2

Sorting parameter DESCENDING

SORT_DIRECTION_NONE : Number=0

Sorting parameter NO_SORT - will remove a sorting condition

Properties

count : Number Read Only

The number of search results found by this search.

emptyQuery : boolean Read Only

Identifies if the query is emtpy when no search term, search parameter or refinement was specified for the search. In case also no result is returned. This "empty" is different to a query with a specified query and with an empty result.

refinedByAttribute : boolean Read Only

The method returns true, if this search is refined by at least one attribute.

refinedSearch : boolean Read Only

Identifies if this was a refined search. A search is a refined search if at least one refinement is part of the query.

searchPhrase : String

The search phrase used in this search.

Constructor Summary

This class does not have a constructor, so you cannot create it directly. To get an instance of this class, use one of the subclass constructors.

Method Summary

addRefinementValues(attributeID : String, values : String) : void

Adds a refinement.

canRelax() : boolean

Identifies if the search can be relaxed without creating a search for all searchable items.

getCount() : Number

Returns the number of search results found by this search.

getRefinementMaxValue(attributeID : String) : String

Returns the maximum refinement value selected in the query for the specific attribute, or null if there is no maximum refinement value or no refinement for that attribute.

getRefinementMinValue(attributeID : String) : String

Returns the minimum refinement value selected in the query for the specific attribute, or null if there is no minimum refinement value or no refinement for that attribute.

getRefinementValue(attributeID : String) : String

Returns the refinement value selected in the query for the specific attribute, or null if there is no refinement for that attribute.

getRefinementValues(attributeID : String) : Collection

Returns the list of selected refinement values for the given attribute as used in the search.

getSearchPhrase() : String

Returns the search phrase used in this search.

static getSearchRedirect(searchPhrase : String) : URLRedirect

Returns an URLRedirect object for a search phrase.

getSortingCondition(attributeID : String) : Number

Returns the sorting condition for a given attribute name.

isEmptyQuery() : boolean

Identifies if the query is emtpy when no search term, search parameter or refinement was specified for the search.

isRefinedByAttribute(attributeID : String) : boolean

Identifies if this search has been refined on the given attribute.

isRefinedByAttribute() : boolean

The method returns true, if this search is refined by at least one attribute.

isRefinedByAttributeValue(attributeID : String, value : String) : boolean

Identifies if this search has been refined on the given attribute and value.

isRefinedSearch() : boolean

Identifies if this was a refined search.

isRefinementByValueRange(attributeID : String) : boolean

Identifies if this search has been refined on the given attribute.

isRefinementByValueRange(attributeID : String, minValue : String, maxValue : String) : boolean

Identifies if this search has been refined on the given attribute and range values.

removeRefinementValues(attributeID : String, values : String) : void

Removes a refinement.

search() : SearchStatus

Execute the search.

setRefinementValueRange(attributeID : String, minValue : String, maxValue : String) : void

Sets a refinement value range for an attribute.

setRefinementValues(attributeID : String, values : String) : void

Sets refinement values for an attribute.

setSearchPhrase(phrase : String) : void

Sets the search phrase used in this search.

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

Sets or removes a sorting condition for the specified attribute.

url(action : String) : URL

Constructs an URL that you can use to re-execute the exact same query.

url(url : URL) : URL

Constructs an URL that you can use to re-execute the exact same query.

urlDefaultSort(url : String) : URL

Constructs an URL that you can use to re-execute the query with a default sorting.

urlDefaultSort(url : URL) : URL

Constructs an URL that you can use to re-execute the query with a default sorting.

urlRefineAttribute(action : String, attributeID : String, value : String) : URL

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

urlRefineAttribute(url : URL, attributeID : String, value : String) : URL

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

urlRefineAttributeValue(action : String, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute.

urlRefineAttributeValue(url : URL, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute.

urlRefineAttributeValueRange(action : String, attributeID : String, minValue : String, maxValue : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value range for a given refinement attribute.

urlRelaxAttribute(action : String, attributeID : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement.

urlRelaxAttribute(url : URL, attributeID : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement.

urlRelaxAttributeValue(action : String, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement.

urlRelaxAttributeValue(url : URL, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement value.

urlSort(action : String, sortBy : String, sortDir : Number) : URL

Constructs an URL that you can use to re-execute the query with a specific sorting criteria.

urlSort(url : URL, sortBy : String, sortDir : Number) : URL

Constructs an URL that you can use to re-execute the query with a specific sorting criteria.

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

Method Detail

addRefinementValues

addRefinementValues(attributeID : String, values : String) : void

Adds a refinement. The method can be called to add an additional query parameter specified as name-value pair. The values string may encode multiple values delimited by the pipe symbol ('|').

Parameters:

attributeID - The ID of the refinement attribute.

values - the refinement value to set

canRelax

canRelax() : boolean

Identifies if the search can be relaxed without creating a search for all searchable items.

Returns:

true if the search can be relaxed without creating a search for all searchable items, false otherwise.

getCount

getCount() : Number

Returns the number of search results found by this search.

Returns:

the number of search results found by this search.

getRefinementMaxValue

getRefinementMaxValue(attributeID : String) : String

Returns the maximum refinement value selected in the query for the specific attribute, or null if there is no maximum refinement value or no refinement for that attribute.

Parameters:

attributeID - the attribute whose refinement value is returned.

Returns:

the maximum refinement value selected in the query for the specific attribute.

getRefinementMinValue

getRefinementMinValue(attributeID : String) : String

Returns the minimum refinement value selected in the query for the specific attribute, or null if there is no minimum refinement value or no refinement for that attribute.

Parameters:

attributeID - the attribute whose refinement value is returned.

Returns:

the minimum refinement value selected in the query for the specific attribute.

getRefinementValue

getRefinementValue(attributeID : String) : String

Returns the refinement value selected in the query for the specific attribute, or null if there is no refinement for that attribute.

Deprecated:

Use getRefinementValues(String) to get the collection of refinement values.

Parameters:

attributeID - the attribute whose refinement value is returned.

Returns:

the refinement value selected in the query for the specific attribute.

getRefinementValues

getRefinementValues(attributeID : String) : Collection

Returns the list of selected refinement values for the given attribute as used in the search.

Parameters:

attributeID - The name of the refinement attribute.

Returns:

A list of values currently selected for the refinement attribute.

getSearchPhrase

getSearchPhrase() : String

Returns the search phrase used in this search.

Returns:

the search phrase used in this search.

getSearchRedirect

static getSearchRedirect(searchPhrase : String) : URLRedirect

Returns an URLRedirect object for a search phrase.

Parameters:

searchPhrase - a search phrase to lookup a URLRedirect for

Returns:

URLRedirect containing the location and status code, null in case no redirect was found for the search phrase.

getSortingCondition

getSortingCondition(attributeID : String) : Number

Returns the sorting condition for a given attribute name. A value of 0 indicates that no sorting condition is set.

Parameters:

attributeID - the attribute name

Returns:

zero if no sorting order set, or the sorting order

isEmptyQuery

isEmptyQuery() : boolean

Identifies if the query is emtpy when no search term, search parameter or refinement was specified for the search. In case also no result is returned. This "empty" is different to a query with a specified query and with an empty result.

Returns:

true if the query is emtpy when no search term, search parameter or refinement was specified for the search.

isRefinedByAttribute

isRefinedByAttribute(attributeID : String) : boolean

Identifies if this search has been refined on the given attribute.

Parameters:

attributeID - The ID of the refinement attribute.

Returns:

True if the search is refined on the attribute, false otherwise.

isRefinedByAttribute

isRefinedByAttribute() : boolean

The method returns true, if this search is refined by at least one attribute.

Returns:

true, if the search is refined by at least one attribute, false otherwise.

isRefinedByAttributeValue

isRefinedByAttributeValue(attributeID : String, value : String) : boolean

Identifies if this search has been refined on the given attribute and value.

Parameters:

attributeID - The ID of the refinement attribute.

value - The value to be checked for inclusion in the refinement.

Returns:

True if the search is refined on the attribute and value, false otherwise.

isRefinedSearch() : boolean

Identifies if this was a refined search. A search is a refined search if at least one refinement is part of the query.

Returns:

true if this is a refined search, false otherwise.

isRefinementByValueRange

isRefinementByValueRange(attributeID : String) : boolean

Identifies if this search has been refined on the given attribute.

Parameters:

attributeID - The ID of the refinement attribute.

Returns:

True if the search is refined on the attribute, false otherwise.

isRefinementByValueRange

isRefinementByValueRange(attributeID : String, minValue : String, maxValue : String) : boolean

Identifies if this search has been refined on the given attribute and range values.

Parameters:

attributeID - The ID of the refinement attribute.

minValue - The minimum value to be checked for inclusion in the refinement.

maxValue - The maximum value to be checked for inclusion in the refinement.

Returns:

True if the search is refined on the attribute and range values, false otherwise.

removeRefinementValues

removeRefinementValues(attributeID : String, values : String) : void

Removes a refinement. The method can be called to remove previously added refinement values. The values string may encode multiple values delimited by the pipe symbol ('|').

Parameters:

attributeID - The ID of the refinement attribute.

values - the refinement value to remove or null to remove all values

search() : SearchStatus

Execute the search.

Returns:

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

setRefinementValueRange

setRefinementValueRange(attributeID : String, minValue : String, maxValue : String) : void

Sets a refinement value range for an attribute. The method can be called to set an additional range query parameter specified as name-range-value pair. The values string can contain only a range boundary. Existing refinement values for the attribute will be removed.

Parameters:

attributeID - The ID of the refinement attribute.

minValue - the minimum refinement boundary value to set or null to remove the minimum boundary

maxValue - the maximum refinement boundary value to set or null to remove the maximum boundary

setRefinementValues

setRefinementValues(attributeID : String, values : String) : void

Sets refinement values for an attribute. The method can be called to set an additional query parameter specified as name-value pair. The value string may encode multiple values delimited by the pipe symbol ('|'). Existing refinement values for the attribute will be removed.

Parameters:

attributeID - The ID of the refinement attribute.

values - the refinement values to set (delimited by '|') or null to remove all values

setSearchPhrase

setSearchPhrase(phrase : String) : void

Sets the search phrase used in this search. The search query parser uses the following operators:

  • PHRASE operator (""), e.g. "cream cheese", "John Lennon"
  • NOT operator (-), e.g. -cargo (will not return results containing "cargo")
  • WILDCARD operator (*), e.g. sho* (will return results containing "shoulder", "shoes" and "shoot")

Parameters:

phrase - the search phrase used in this search.

setSortingCondition

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

url

url(action : String) : URL

Constructs an URL that you can use to re-execute the exact same query. The provided parameter must be an action, e.g. 'Search-Show'.

Parameters:

action - the pipeline action.

Returns:

an URL that can be used to re-execute the exact same query.

url

url(url : URL) : URL

Constructs an URL that you can use to re-execute the exact same query. The search specific parameter are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - the url to use.

Returns:

a new url URL that can be used to re-execute the exact same query.

urlDefaultSort

urlDefaultSort(url : String) : URL

Constructs an URL that you can use to re-execute the query with a default sorting. The provided parameter must be an action, e.g. 'Search-Show'.

Parameters:

url - url or pipeline name

Returns:

the new URL.

urlDefaultSort

urlDefaultSort(url : URL) : URL

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

Parameters:

url - url or pipeline name

Returns:

the new URL.

urlRefineAttribute

urlRefineAttribute(action : String, attributeID : String, value : String) : URL

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

Parameters:

action - the pipeline action.

attributeID - the ID of the refinement attribute.

value - the value for the refinement attribute.

Returns:

the new URL.

urlRefineAttribute

urlRefineAttribute(url : URL, attributeID : String, value : String) : URL

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

Parameters:

url - url

attributeID - the ID of the refinement attribute

value - value for the refinement attribute

Returns:

the new URL.

urlRefineAttributeValue

urlRefineAttributeValue(action : String, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute. The provided value will be added to the set of allowed values for the refinement attribute. This basically broadens the search result.

Parameters:

action - the pipeline action.

attributeID - the ID of the refinement attribute.

value - the additional value for the refinement attribute.

Returns:

the new URL.

urlRefineAttributeValue

urlRefineAttributeValue(url : URL, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value for a given refinement attribute. The provided value will be added to the set of allowed values for the refinement attribute. This basically broadens the search result. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - url

attributeID - ID of the refinement attribute

value - the additional value for the refinement attribute

Returns:

the new URL.

urlRefineAttributeValueRange

urlRefineAttributeValueRange(action : String, attributeID : String, minValue : String, maxValue : String) : URL

Constructs an URL that you can use to re-execute the query with an additional refinement value range for a given refinement attribute. The provided value range will be replace to the existing value range for the refinement attribute. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

action - the pipeline action.

attributeID - ID of the refinement attribute

minValue - the min value for the refinement attribute

maxValue - the max value for the refinement attribute

Returns:

the new URL.

urlRelaxAttribute

urlRelaxAttribute(action : String, attributeID : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement. The value for the action parameter must be a pipeline action, e.g. 'Search-Show'.

Parameters:

action - the pipeline action.

attributeID - ID of the refinement attribute to be removed

Returns:

the new URL.

urlRelaxAttribute

urlRelaxAttribute(url : URL, attributeID : String) : URL

Constructs an URL that you can use to re-execute the query without the specified 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 url to use.

attributeID - the ID of the refinement attribute to be removed.

Returns:

the new URL.

urlRelaxAttributeValue

urlRelaxAttributeValue(action : String, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement. The value for the action parameter must be a pipeline action, e.g. 'Search-Show'.

Parameters:

action - the pipeline action.

attributeID - ID of the refinement attribute to be removed

value - the value that should be removed from the list of refinement values.

Returns:

the new URL.

urlRelaxAttributeValue

urlRelaxAttributeValue(url : URL, attributeID : String, value : String) : URL

Constructs an URL that you can use to re-execute the query without the specified refinement value. 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.

attributeID - the ID of the refinement attribute to relax the value for.

value - the value that should be removed from the list of refinement values.

Returns:

the new URL.

urlSort

urlSort(action : String, sortBy : String, sortDir : Number) : URL

Constructs an URL that you can use to re-execute the query with a specific sorting criteria. This criteria will overwrite all previous sort critiria. The provided parameter must be an action, e.g. 'Search-Show'.

Parameters:

action - Pipeline action

sortBy - ID of the sort attribute

sortDir - Sort direction. 1 - ASCENDING (default), 2 - DESCENDING

Returns:

The new URL.

urlSort

urlSort(url : URL, sortBy : String, sortDir : Number) : URL

Constructs an URL that you can use to re-execute the query with a specific sorting criteria. This criteria will overwrite all previous sort critiria. The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.

Parameters:

url - URL

sortBy - ID of the sort attribute

sortDir - Sort direction. 1 - ASCENDING (default), 2 - DESCENDING

Returns:

The new URL.