Class SearchRefinementDefinition

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

Common search refinement definition base class.

All Known Subclasses 

ContentSearchRefinementDefinition, ProductSearchRefinementDefinition

Property Summary 

Property	Description
attributeID: String (read-only)	Returns the attribute ID.
attributeRefinement: Boolean (read-only)	Identifies if this is an attribute refinement.
cutoffThreshold: Number (read-only)	Returns the cut-off threshold.
displayName: String (read-only)	Returns the display name.
valueTypeCode: Number (read-only)	Returns a code for the data type used for this search refinement definition.

Constructor Summary 

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

Method Summary 

Method	Description
getAttributeID()	Returns the attribute ID.
getCutoffThreshold()	Returns the cut-off threshold.
getDisplayName()	Returns the display name.
getValueTypeCode()	Returns a code for the data type used for this search refinement definition.
isAttributeRefinement()	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

Property Details 

attributeID 

attributeID: String (read-only)

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

---

attributeRefinement 

attributeRefinement: Boolean (read-only)

Identifies if this is an attribute refinement.

---

cutoffThreshold 

cutoffThreshold: Number (read-only)

Returns the cut-off threshold.

---

displayName 

displayName: String (read-only)

Returns the display name.

---

valueTypeCode 

valueTypeCode: Number (read-only)

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

---

Method Details 

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.

---