Script: Class dw.catalog.SortingOption

Class SortingOption

Represents an option for how to sort products in storefront search results.

Properties

description : String Read Only

The description of the sorting option for the current locale.

displayName : String Read Only

The display name of the of the sorting option for the current locale.

ID : String Read Only

The ID of the sorting option.

sortingRule : SortingRule Read Only

The sorting rule for this sorting option, or null if there is no associated rule.

Constructor Summary

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

Method Summary

getDescription() : String

Returns the description of the sorting option for the current locale.

getDisplayName() : String

Returns the display name of the of the sorting option for the current locale.

getID() : String

Returns the ID of the sorting option.

getSortingRule() : SortingRule

Returns the sorting rule for this sorting option, or null if there is no associated rule.

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

getDescription

getDescription() : String

Returns the description of the sorting option for the current locale.

Returns:

The value of the property for the current locale, or null if it wasn't found.

getDisplayName

getDisplayName() : String

Returns the display name of the of the sorting option for the current locale.

Returns:

The value of the property for the current locale, or null if it wasn't found.

getID

getID() : String

Returns the ID of the sorting option.

Returns:

sorting option ID

getSortingRule

getSortingRule() : SortingRule

Returns the sorting rule for this sorting option, or null if there is no associated rule.

Returns:

a ProductSortingRule instance representing the rule for this option or null.