Class SearchRefinementValue

• TopLevel.Object
  • dw.catalog.SearchRefinementValue

Represents the value of a product or content search refinement.

All Known Subclasses 

ContentSearchRefinementValue, ProductSearchRefinementValue

Property Summary 

Property	Description
ID: String (read-only)	Returns the refinement value’s ID.
description: String (read-only)	Returns the optional refinement value description in the current locale.
displayValue: String (read-only)	Returns the refinement display value.
hitCount: Number (read-only)	Returns the hit count value.
presentationID: String (read-only)	Returns the optional presentation ID associated with this refinement value.
value: String (read-only)	Returns the refinement value.

Constructor Summary 

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

Method Summary 

Method	Description
getDescription()	Returns the optional refinement value description in the current locale.
getDisplayValue()	Returns the refinement display value.
getHitCount()	Returns the hit count value.
getID()	Returns the refinement value’s ID.
getPresentationID()	Returns the optional presentation ID associated with this refinement value.
getValue()	Returns the refinement value.

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

Property Details 

ID 

ID: String (read-only)

Returns the refinement value's ID. For attribute refinements, this will be the ID of the corresponding ObjectAttributeDefinition. This ID is included in the querystring parameter names returned by the URL-generating methods of SearchModel. For price and category refinements, this value will be empty.

---

description 

description: String (read-only)

Returns the optional refinement value description in the current locale.

---

displayValue 

displayValue: String (read-only)

Returns the refinement display value. For attribute refinements, this is the appropriate display value based on optional value display names within the object attribute definition. If no display name is defined, the value itself is returned. For category refinements, this is the display name of the category in the current locale. For price refinements, this is a string representation of the range appropriate for display.

---

hitCount 

hitCount: Number (read-only)

Returns the hit count value.

---

presentationID 

presentationID: String (read-only)

Returns the optional presentation ID associated with this refinement value. The presentation ID can be used, for example, to associate an ID with an HTML widget.

---

value 

value: String (read-only)

Returns the refinement value. For attribute refinements, this is the attribute value if the refinement values are unbucketed, or the bucket display name if the values are bucketed. This value is included in the querystring parameter values returned by the URL-generating methods of SearchModel. For price refinements, the value will be a string representation of the price range lower bound. For category refinements, the value will be a category ID.

---

Method Details 

getDescription() 

getDescription(): String

Returns the optional refinement value description in the current locale.

Returns:

• the optional refinement value description in the current locale, or null if none is defined.

---

getDisplayValue() 

getDisplayValue(): String

Returns the refinement display value. For attribute refinements, this is the appropriate display value based on optional value display names within the object attribute definition. If no display name is defined, the value itself is returned. For category refinements, this is the display name of the category in the current locale. For price refinements, this is a string representation of the range appropriate for display.

Returns:

• the refinement display value in the current locale.

---

getHitCount() 

getHitCount(): Number

Returns the hit count value.

Returns:

• the hit count value.

---

getID() 

getID(): String

Returns the refinement value's ID. For attribute refinements, this will be the ID of the corresponding ObjectAttributeDefinition. This ID is included in the querystring parameter names returned by the URL-generating methods of SearchModel. For price and category refinements, this value will be empty.

Returns:

• the refinement value's ID.

---

getPresentationID() 

getPresentationID(): String

Returns the optional presentation ID associated with this refinement value. The presentation ID can be used, for example, to associate an ID with an HTML widget.

Returns:

• the presentation ID, or null if none is defined.

---

getValue() 

getValue(): String

Returns the refinement value. For attribute refinements, this is the attribute value if the refinement values are unbucketed, or the bucket display name if the values are bucketed. This value is included in the querystring parameter values returned by the URL-generating methods of SearchModel. For price refinements, the value will be a string representation of the price range lower bound. For category refinements, the value will be a category ID.

Returns:

• the refinement value.

---