Class SearchRefinementDefinition

• Object
  • dw.object.PersistentObject
    • dw.object.ExtensibleObject
      • dw.catalog.SearchRefinementDefinition

Common search refinement definition base class.

All Known Subclasses

ContentSearchRefinementDefinition, ProductSearchRefinementDefinition

Properties

attributeID : String Read Only

The attribute ID. If the refinement definition is not an attribute refinement, the method returns an empty string.

attributeRefinement : boolean Read Only

Identifies if this is an attribute refinement.

cutoffThreshold : Number Read Only

The cut-off threshold.

displayName : String Read Only

The display name.

valueTypeCode : Number Read Only

A code for the data type used for this search refinement definition. See constants defined in ObjectAttributeDefinition.

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

getAttributeID() : String

Returns the attribute ID.

getCutoffThreshold() : Number

Returns the cut-off threshold.

getDisplayName() : String

Returns the display name.

getValueTypeCode() : Number

Returns a code for the data type used for this search refinement definition.

isAttributeRefinement() : boolean

Identifies if this is an attribute refinement.

Methods inherited from class ExtensibleObject

describe, getCustom

Methods inherited from class PersistentObject

getCreationDate, getLastModified, getUUID

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

getAttributeID

getAttributeID() : String

Returns the attribute ID. If the refinement definition is not an attribute refinement, the method returns an empty string.

Returns:

the attribute ID.

getCutoffThreshold

getCutoffThreshold() : Number

Returns the cut-off threshold.

Returns:

the cut-off threshold.

getDisplayName

getDisplayName() : String

Returns the display name.

Returns:

the display name.

getValueTypeCode

getValueTypeCode() : Number

Returns a code for the data type used for this search refinement definition. See constants defined in ObjectAttributeDefinition.

Returns:

a code for the data type used for this search refinement definition. See constants defined in ObjectAttributeDefinition.

isAttributeRefinement

isAttributeRefinement() : boolean

Identifies if this is an attribute refinement.

Returns:

true if this is an attribute refinement, false otherwise.