sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/dw_catalog/SearchRefinementDefinition.md

@@ -1,146 +0,0 @@
-## Package: dw.catalog
-
-# Class SearchRefinementDefinition
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.SearchRefinementDefinition
-
-## Description
-
-Common search refinement definition base class.
-
-## Properties
-
-### attributeID
-
-**Type:** String (Read Only)
-
-The attribute ID. If the refinement definition is not an
- attribute refinement, the method returns an empty string.
-
-### attributeRefinement
-
-**Type:** boolean (Read Only)
-
-Identifies if this is an attribute refinement.
-
-### cutoffThreshold
-
-**Type:** Number (Read Only)
-
-The cut-off threshold.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name.
-
-### valueTypeCode
-
-**Type:** Number (Read Only)
-
-A code for the data type used for this search refinement definition. See constants
- defined in ObjectAttributeDefinition.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAttributeID
-
-**Signature:** `getAttributeID() : String`
-
-Returns the attribute ID.
-
-### getCutoffThreshold
-
-**Signature:** `getCutoffThreshold() : Number`
-
-Returns the cut-off threshold.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name.
-
-### getValueTypeCode
-
-**Signature:** `getValueTypeCode() : Number`
-
-Returns a code for the data type used for this search refinement definition.
-
-### isAttributeRefinement
-
-**Signature:** `isAttributeRefinement() : boolean`
-
-Identifies if this is an attribute refinement.
-
-## Method Detail
-
-## Method Details
-
-### getAttributeID
-
-**Signature:** `getAttributeID() : String`
-
-**Description:** Returns the attribute ID. If the refinement definition is not an attribute refinement, the method returns an empty string.
-
-**Returns:**
-
-the attribute ID.
-
----
-
-### getCutoffThreshold
-
-**Signature:** `getCutoffThreshold() : Number`
-
-**Description:** Returns the cut-off threshold.
-
-**Returns:**
-
-the cut-off threshold.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the display name.
-
-**Returns:**
-
-the display name.
-
----
-
-### getValueTypeCode
-
-**Signature:** `getValueTypeCode() : Number`
-
-**Description:** 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
-
-**Signature:** `isAttributeRefinement() : boolean`
-
-**Description:** Identifies if this is an attribute refinement.
-
-**Returns:**
-
-true if this is an attribute refinement, false otherwise.
-
----

package/docs/dw_catalog/SearchRefinementValue.md

@@ -1,185 +0,0 @@
-## Package: dw.catalog
-
-# Class SearchRefinementValue
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.SearchRefinementValue
-
-## Description
-
-Represents the value of a product or content search refinement.
-
-## Properties
-
-### description
-
-**Type:** String (Read Only)
-
-The optional refinement value description in the current locale.
-
-### displayValue
-
-**Type:** 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
-
-**Type:** Number (Read Only)
-
-The hit count value.
-
-### ID
-
-**Type:** 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
-
-**Type:** 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
-
-**Type:** 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
-
-## Method Summary
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the optional refinement value description in the current locale.
-
-### getDisplayValue
-
-**Signature:** `getDisplayValue() : String`
-
-Returns the refinement display value.
-
-### getHitCount
-
-**Signature:** `getHitCount() : Number`
-
-Returns the hit count value.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the refinement value's ID.
-
-### getPresentationID
-
-**Signature:** `getPresentationID() : String`
-
-Returns the optional presentation ID associated with this refinement value.
-
-### getValue
-
-**Signature:** `getValue() : String`
-
-Returns the refinement value.
-
-## Method Detail
-
-## Method Details
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** 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
-
-**Signature:** `getDisplayValue() : String`
-
-**Description:** 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.
-
----
-
-### getHitCount
-
-**Signature:** `getHitCount() : Number`
-
-**Description:** Returns the hit count value.
-
-**Returns:**
-
-the hit count value.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** 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
-
-**Signature:** `getPresentationID() : String`
-
-**Description:** 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
-
-**Signature:** `getValue() : String`
-
-**Description:** 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.
-
----

package/docs/dw_catalog/SearchRefinements.md

@@ -1,180 +0,0 @@
-## Package: dw.catalog
-
-# Class SearchRefinements
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.SearchRefinements
-
-## Description
-
-Common search refinements base class.
-
-## Constants
-
-### ASCENDING
-
-**Type:** Number = 0
-
-Flag for an ascending sort.
-
-### DESCENDING
-
-**Type:** Number = 1
-
-Flag for a descending sort.
-
-### SORT_VALUE_COUNT
-
-**Type:** Number = 1
-
-Flag for sorting on value count.
-
-### SORT_VALUE_NAME
-
-**Type:** Number = 0
-
-Flag for sorting on value name.
-
-## Properties
-
-### allRefinementDefinitions
-
-**Type:** Collection (Read Only)
-
-A sorted list of refinement definitions that are appropriate for
- the deepest common category (or deepest common folder) of the search
- result. The method concatenates the sorted refinement definitions per
- category starting at the root category until reaching the deepest common
- category.
-
- The method does not filter out refinement definitions that do
- not provide values for the current search result and can therefore also
- be used on empty search results.
-
-### refinementDefinitions
-
-**Type:** Collection (Read Only)
-
-A sorted list of refinement definitions that are appropriate for
- the deepest common category (or deepest common folder) of the search
- result. The method concatenates the sorted refinement definitions per category
- starting at the root category until reaching the deepest common category.
-
- The method also filters out refinement definitions that do not provide
- any values for the current search result.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAllRefinementDefinitions
-
-**Signature:** `getAllRefinementDefinitions() : Collection`
-
-Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result.
-
-### getAllRefinementValues
-
-**Signature:** `getAllRefinementValues(attributeName : String) : Collection`
-
-Returns a sorted collection of refinement values for the given refinement attribute.
-
-### getAllRefinementValues
-
-**Signature:** `getAllRefinementValues(attributeName : String, sortMode : Number, sortDirection : Number) : Collection`
-
-Returns a sorted collection of refinement values for the given refinement attribute.
-
-### getRefinementDefinitions
-
-**Signature:** `getRefinementDefinitions() : Collection`
-
-Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result.
-
-### getRefinementValues
-
-**Signature:** `getRefinementValues(attributeName : String, sortMode : Number, sortDirection : Number) : Collection`
-
-Returns a collection of refinement values for the given refinement attribute, sorting mode and sorting direction.
-
-## Method Detail
-
-## Method Details
-
-### getAllRefinementDefinitions
-
-**Signature:** `getAllRefinementDefinitions() : Collection`
-
-**Description:** Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category. The method does not filter out refinement definitions that do not provide values for the current search result and can therefore also be used on empty search results.
-
-**Returns:**
-
-A sorted list of refinement definitions appropriate for the search result (based on its deepest common category)
-
----
-
-### getAllRefinementValues
-
-**Signature:** `getAllRefinementValues(attributeName : String) : Collection`
-
-**Description:** Returns a sorted collection of refinement values for the given refinement attribute. The returned collection includes all refinement values for which the hit count is greater than 0 within the search result when the passed attribute is excluded from filtering the search hits but all other refinement filters are still applied. This method is useful for rendering broadening options for attributes that the search is currently refined by. This method does NOT return refinement values independent of the search result. For product search refinements, this method may return slightly different results based on the "value set" property of the refinement definition. See ProductSearchRefinements.getAllRefinementValues(ProductSearchRefinementDefinition) for details.
-
-**Parameters:**
-
-- `attributeName`: The name of the attribute to return refinement values for.
-
-**Returns:**
-
-The collection of SearchRefinementValue instances, sorted according to the settings of the refinement definition, or null if there is no refinement definition for the passed attribute name.
-
----
-
-### getAllRefinementValues
-
-**Signature:** `getAllRefinementValues(attributeName : String, sortMode : Number, sortDirection : Number) : Collection`
-
-**Description:** Returns a sorted collection of refinement values for the given refinement attribute. In general, the returned collection includes all refinement values for which hit count is greater than 0 within the search result assuming that: The passed refinement attribute is NOT used to filter the search hits. All other refinements are still applied. This is useful for rendering broadening options for the refinement definitions that the search is already refined by. It is important to note that this method does NOT return refinement values independent of the search result. For product search refinements, this method may return slightly different results based on the "value set" of the refinement definition. See ProductSearchRefinements.getAllRefinementValues(ProductSearchRefinementDefinition) for details.
-
-**Parameters:**
-
-- `attributeName`: The name of the attribute to return refinement values for.
-- `sortMode`: The sort mode to use to control how the collection is sorted.
-- `sortDirection`: The sort direction to use.
-
-**Returns:**
-
-The collection of SearchRefinementValue instances, sorted according to the passed parameters.
-
----
-
-### getRefinementDefinitions
-
-**Signature:** `getRefinementDefinitions() : Collection`
-
-**Description:** Returns a sorted list of refinement definitions that are appropriate for the deepest common category (or deepest common folder) of the search result. The method concatenates the sorted refinement definitions per category starting at the root category until reaching the deepest common category. The method also filters out refinement definitions that do not provide any values for the current search result.
-
-**Returns:**
-
-A sorted list of refinement definitions appropriate for the search result (based on its deepest common category)
-
----
-
-### getRefinementValues
-
-**Signature:** `getRefinementValues(attributeName : String, sortMode : Number, sortDirection : Number) : Collection`
-
-**Description:** Returns a collection of refinement values for the given refinement attribute, sorting mode and sorting direction.
-
-**Parameters:**
-
-- `attributeName`: The attribute name to use when collection refinement values.
-- `sortMode`: The sort mode to use to control how the collection is sorted.
-- `sortDirection`: The sort direction to use.
-
-**Returns:**
-
-The collection of refinement values.
-
----

package/docs/dw_catalog/SortingOption.md

@@ -1,120 +0,0 @@
-## Package: dw.catalog
-
-# Class SortingOption
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.catalog.SortingOption
-
-## Description
-
-Represents an option for how to sort products in storefront search results.
-
-## Properties
-
-### description
-
-**Type:** String (Read Only)
-
-The description of the sorting option for the current locale.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name of the of the sorting option for the current locale.
-
-### ID
-
-**Type:** String (Read Only)
-
-The ID of the sorting option.
-
-### sortingRule
-
-**Type:** SortingRule (Read Only)
-
-The sorting rule for this sorting option,
- or null if there is no associated rule.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the description of the sorting option for the current locale.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name of the of the sorting option for the current locale.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the ID of the sorting option.
-
-### getSortingRule
-
-**Signature:** `getSortingRule() : SortingRule`
-
-Returns the sorting rule for this sorting option, or null if there is no associated rule.
-
-## Method Detail
-
-## Method Details
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** 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
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** 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
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the ID of the sorting option.
-
-**Returns:**
-
-sorting option ID
-
----
-
-### getSortingRule
-
-**Signature:** `getSortingRule() : SortingRule`
-
-**Description:** 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.
-
----

package/docs/dw_catalog/SortingRule.md

@@ -1,47 +0,0 @@
-## Package: dw.catalog
-
-# Class SortingRule
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.catalog.SortingRule
-
-## Description
-
-Represents a product sorting rule for use with the ProductSearchModel.
-
-## Properties
-
-### ID
-
-**Type:** String (Read Only)
-
-The ID of the sorting rule.
-
-## Constructor Summary
-
-## Method Summary
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the ID of the sorting rule.
-
-## Method Detail
-
-## Method Details
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the ID of the sorting rule.
-
-**Returns:**
-
-sorting rule ID
-
----