dw.catalog
Class SearchRefinementValue
dw.catalog.SearchRefinementValue
Represents the value of a product or content search refinement.
All Known Subclasses
Properties
description
:
String
(Read Only)
The optional refinement value description in the current locale.
displayValue
:
String
(Read Only)
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
:
Number
(Read Only)
The hit count value.
ID
:
String
(Read Only)
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.
presentationID
:
String
(Read Only)
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
:
String
(Read Only)
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.
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
getDescription()
:
String
Returns the optional refinement value description in the current locale.
getDisplayValue()
:
String
Returns the refinement display value.
getHitCount()
:
Number
Returns the hit count value.
getPresentationID()
:
String
Returns the optional presentation ID associated with this 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
Method Detail
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.
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.
© Copyright 2000-2024, salesforce.com inc. All rights reserved. Various trademarks held by their respective owners.