Class SearchRefinementDefinition
Common search refinement definition base class.
ContentSearchRefinementDefinition, ProductSearchRefinementDefinition
| 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. |
This class does not have a constructor, so you cannot create it directly.
| 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. |
getCreationDate, getLastModified, getUUID
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
- attributeID: String
(read-only) Returns 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) 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. See constants defined in ObjectAttributeDefinition.
- 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(): Number
Returns the cut-off threshold.
Returns:
- the cut-off threshold.
- getDisplayName(): String
Returns the display name.
Returns:
- the display name.
- 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(): Boolean
Identifies if this is an attribute refinement.
Returns:
- true if this is an attribute refinement, false otherwise.