sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_catalog/ProductMgr.md

@@ -1,138 +0,0 @@
-## Package: dw.catalog
-
-# Class ProductMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.ProductMgr
-
-## Description
-
-Provides helper methods for getting products based on Product ID or Catalog.
-
-## Constructor Summary
-
-## Method Summary
-
-### getProduct
-
-**Signature:** `static getProduct(productID : String) : Product`
-
-Returns the product with the specified id.
-
-### queryAllSiteProducts
-
-**Signature:** `static queryAllSiteProducts() : SeekableIterator`
-
-Returns all products assigned to the current site.
-
-### queryAllSiteProductsSorted
-
-**Signature:** `static queryAllSiteProductsSorted() : SeekableIterator`
-
-Returns all products assigned to the current site.
-
-### queryProductsInCatalog
-
-**Signature:** `static queryProductsInCatalog(catalog : Catalog) : SeekableIterator`
-
-Returns all products assigned to the the specified catalog, where assignment has the same meaning as it does for queryAllSiteProducts().
-
-### queryProductsInCatalogSorted
-
-**Signature:** `static queryProductsInCatalogSorted(catalog : Catalog) : SeekableIterator`
-
-Returns all products assigned to the the specified catalog.
-
-## Method Detail
-
-## Method Details
-
-### getProduct
-
-**Signature:** `static getProduct(productID : String) : Product`
-
-**Description:** Returns the product with the specified id.
-
-**Parameters:**
-
-- `productID`: the product identifier.
-
-**Returns:**
-
-Product for specified id or null
-
----
-
-### queryAllSiteProducts
-
-**Signature:** `static queryAllSiteProducts() : SeekableIterator`
-
-**Description:** Returns all products assigned to the current site. A product is assigned to a site if it is assigned to at least one category of the site catalog or it is a variant and it's master product is assigned to the current site It is strongly recommended to call close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-**Returns:**
-
-Iterator of all site products
-
-**See Also:**
-
-SeekableIterator.close()
-
----
-
-### queryAllSiteProductsSorted
-
-**Signature:** `static queryAllSiteProductsSorted() : SeekableIterator`
-
-**Description:** Returns all products assigned to the current site. Works like queryAllSiteProducts(), but additionally sorts the result set by product ID. It is strongly recommended to call close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-**Returns:**
-
-Iterator of all site products sorted by product ID.
-
-**See Also:**
-
-SeekableIterator.close()
-
----
-
-### queryProductsInCatalog
-
-**Signature:** `static queryProductsInCatalog(catalog : Catalog) : SeekableIterator`
-
-**Description:** Returns all products assigned to the the specified catalog, where assignment has the same meaning as it does for queryAllSiteProducts(). It is strongly recommended to call close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-**Parameters:**
-
-- `catalog`: The catalog whose assigned products should be returned.
-
-**Returns:**
-
-Iterator of all products assigned to specified catalog.
-
-**See Also:**
-
-SeekableIterator.close()
-
----
-
-### queryProductsInCatalogSorted
-
-**Signature:** `static queryProductsInCatalogSorted(catalog : Catalog) : SeekableIterator`
-
-**Description:** Returns all products assigned to the the specified catalog. Works like queryProductsInCatalog(), but additionally sorts the result set by product ID. It is strongly recommended to call close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-**Parameters:**
-
-- `catalog`: The catalog whose assigned products should be returned.
-
-**Returns:**
-
-Iterator of all products assigned to specified catalog sorted by product ID.
-
-**See Also:**
-
-SeekableIterator.close()
-
----

package/docs/dw_catalog/ProductOption.md

@@ -1,214 +0,0 @@
-## Package: dw.catalog
-
-# Class ProductOption
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.ProductOption
-
-## Description
-
-Represents a product option.
-
-## Properties
-
-### defaultValue
-
-**Type:** ProductOptionValue (Read Only)
-
-The default value for the product option.
-
-### description
-
-**Type:** String (Read Only)
-
-The product option's short description in the current locale.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The product option's display name in the current locale.
-
-### htmlName
-
-**Type:** String (Read Only)
-
-An HTML representation of the option id.
-
-### ID
-
-**Type:** String (Read Only)
-
-The product option ID.
-
-### image
-
-**Type:** MediaFile (Read Only)
-
-The product option's image.
-
-### optionValues
-
-**Type:** Collection (Read Only)
-
-A collection containing the product option values.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDefaultValue
-
-**Signature:** `getDefaultValue() : ProductOptionValue`
-
-Returns the default value for the product option.
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the product option's short description in the current locale.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the product option's display name in the current locale.
-
-### getHtmlName
-
-**Signature:** `getHtmlName() : String`
-
-Returns an HTML representation of the option id.
-
-### getHtmlName
-
-**Signature:** `getHtmlName(prefix : String) : String`
-
-Returns an HTML representation of the option id with the custom prefix.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the product option ID.
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-Returns the product option's image.
-
-### getOptionValues
-
-**Signature:** `getOptionValues() : Collection`
-
-Returns a collection containing the product option values.
-
-## Method Detail
-
-## Method Details
-
-### getDefaultValue
-
-**Signature:** `getDefaultValue() : ProductOptionValue`
-
-**Description:** Returns the default value for the product option.
-
-**Returns:**
-
-the object for the relation 'defaultValue'
-
----
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the product option's short description in the current locale.
-
-**Returns:**
-
-The value of the short description in the current locale, or null if it wasn't found.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the product option's display name in the current locale.
-
-**Returns:**
-
-The value of the display name in the current locale, or null if it wasn't found.
-
----
-
-### getHtmlName
-
-**Signature:** `getHtmlName() : String`
-
-**Description:** Returns an HTML representation of the option id.
-
-**Returns:**
-
-an HTML representation of the option id.
-
----
-
-### getHtmlName
-
-**Signature:** `getHtmlName(prefix : String) : String`
-
-**Description:** Returns an HTML representation of the option id with the custom prefix.
-
-**Parameters:**
-
-- `prefix`: a custom prefix for the html name.
-
-**Returns:**
-
-an HTML representation of the option id.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the product option ID.
-
-**Returns:**
-
-the product option identifier.
-
----
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-**Description:** Returns the product option's image.
-
-**Returns:**
-
-the product option's image.
-
----
-
-### getOptionValues
-
-**Signature:** `getOptionValues() : Collection`
-
-**Description:** Returns a collection containing the product option values.
-
-**Returns:**
-
-a collection containing the product option values.
-
----

package/docs/dw_catalog/ProductOptionModel.md

@@ -1,246 +0,0 @@
-## Package: dw.catalog
-
-# Class ProductOptionModel
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.ProductOptionModel
-
-## Description
-
-This class represents the option model of a specific product and for a specific currency. It provides accessor methods to the configured options and the values of those options. It has also methods to set a specific selection of option values.
-
-## Properties
-
-### options
-
-**Type:** Collection (Read Only)
-
-The collection of product options.
-
-## Constructor Summary
-
-## Method Summary
-
-### getOption
-
-**Signature:** `getOption(optionID : String) : ProductOption`
-
-Returns the product option for the specified ID.
-
-### getOptions
-
-**Signature:** `getOptions() : Collection`
-
-Returns the collection of product options.
-
-### getOptionValue
-
-**Signature:** `getOptionValue(option : ProductOption, valueID : String) : ProductOptionValue`
-
-Returns the product option value object for the passed value id and in the context of the passed option.
-
-### getOptionValues
-
-**Signature:** `getOptionValues(option : ProductOption) : Collection`
-
-Returns a collection of product option values for the specified product option.
-
-### getPrice
-
-**Signature:** `getPrice(optionValue : ProductOptionValue) : Money`
-
-Returns the effective price of the specified option value.
-
-### getSelectedOptionValue
-
-**Signature:** `getSelectedOptionValue(option : ProductOption) : ProductOptionValue`
-
-Returns the selected value for the specified product option.
-
-### isSelectedOptionValue
-
-**Signature:** `isSelectedOptionValue(option : ProductOption, value : ProductOptionValue) : boolean`
-
-Returns true if the specified option value is the one currently selected, false otherwise.
-
-### setSelectedOptionValue
-
-**Signature:** `setSelectedOptionValue(option : ProductOption, value : ProductOptionValue) : void`
-
-Updates the selection of the specified option based on the specified value.
-
-### url
-
-**Signature:** `url(action : String, varOptionAndValues : Object...) : URL`
-
-Returns a URL that can be used to select one or more option values.
-
-### urlSelectOptionValue
-
-**Signature:** `urlSelectOptionValue(action : String, option : ProductOption, value : ProductOptionValue) : String`
-
-Returns an URL that can be used to select a specific value of a specific option.
-
-## Method Detail
-
-## Method Details
-
-### getOption
-
-**Signature:** `getOption(optionID : String) : ProductOption`
-
-**Description:** Returns the product option for the specified ID.
-
-**Parameters:**
-
-- `optionID`: the product option identifier.
-
-**Returns:**
-
-the product option for the specified ID.
-
----
-
-### getOptions
-
-**Signature:** `getOptions() : Collection`
-
-**Description:** Returns the collection of product options.
-
-**Returns:**
-
-Collection of Product Options.
-
----
-
-### getOptionValue
-
-**Signature:** `getOptionValue(option : ProductOption, valueID : String) : ProductOptionValue`
-
-**Description:** Returns the product option value object for the passed value id and in the context of the passed option.
-
-**Parameters:**
-
-- `option`: The option to get the specified value for.
-- `valueID`: The id of the value to retrieve
-
-**Returns:**
-
-a value for the specified product option and value id
-
----
-
-### getOptionValues
-
-**Signature:** `getOptionValues(option : ProductOption) : Collection`
-
-**Description:** Returns a collection of product option values for the specified product option.
-
-**Parameters:**
-
-- `option`: the option for which we want to extract the collection of product option values.
-
-**Returns:**
-
-a collection of product option values for the specified product option.
-
----
-
-### getPrice
-
-**Signature:** `getPrice(optionValue : ProductOptionValue) : Money`
-
-**Description:** Returns the effective price of the specified option value.
-
-**Parameters:**
-
-- `optionValue`: the product option value to use.
-
-**Returns:**
-
-the effective price of the specified option value.
-
----
-
-### getSelectedOptionValue
-
-**Signature:** `getSelectedOptionValue(option : ProductOption) : ProductOptionValue`
-
-**Description:** Returns the selected value for the specified product option. If no option values was set as selected option explicitly, the method returns the default option value for this option.
-
-**Parameters:**
-
-- `option`: The option to get the selected value for.
-
-**Returns:**
-
-a selected value for the specified product option.
-
----
-
-### isSelectedOptionValue
-
-**Signature:** `isSelectedOptionValue(option : ProductOption, value : ProductOptionValue) : boolean`
-
-**Description:** Returns true if the specified option value is the one currently selected, false otherwise.
-
-**Parameters:**
-
-- `option`: the product option.
-- `value`: the product option value.
-
-**Returns:**
-
-true if the specified option value is the one currently selected, false otherwise.
-
----
-
-### setSelectedOptionValue
-
-**Signature:** `setSelectedOptionValue(option : ProductOption, value : ProductOptionValue) : void`
-
-**Description:** Updates the selection of the specified option based on the specified value.
-
-**Parameters:**
-
-- `option`: the option to update.
-- `value`: the value to use when updating the product option.
-
----
-
-### url
-
-**Signature:** `url(action : String, varOptionAndValues : Object...) : URL`
-
-**Description:** Returns a URL that can be used to select one or more option values. The optional varOptionAndValues argument can be empty, or can contain one or more option / value pairs. This variable list must be even in length, with options and values alternating. If the list is odd in length, the last argument will be ignored. Options can be specified as instances of ProductOption, or String option ID. Values can be specified as instances of ProductOptionValue or as strings representing the value ID. If a parameter is invalid, then the parameter pair is not included in the generated URL. The returned URL will contain options and values already selected in the product option model, as well as options and values specified as method parameters. This includes option values explicitly selected and implicitly selected by default.
-
-**Parameters:**
-
-- `action`: The pipeline action, must not be null.
-- `varOptionAndValues`: Variable length list of options and values.
-
-**Returns:**
-
-The constructed URL.
-
----
-
-### urlSelectOptionValue
-
-**Signature:** `urlSelectOptionValue(action : String, option : ProductOption, value : ProductOptionValue) : String`
-
-**Description:** Returns an URL that can be used to select a specific value of a specific option.
-
-**Parameters:**
-
-- `action`: the action to use.
-- `option`: the option to use when constructing the URL.
-- `value`: the value to use when constructing the URL.
-
-**Returns:**
-
-The constructed URL as string.
-
----

package/docs/dw_catalog/ProductOptionValue.md

@@ -1,123 +0,0 @@
-## Package: dw.catalog
-
-# Class ProductOptionValue
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.ProductOptionValue
-
-## Description
-
-Represents the value of a product option.
-
-## Properties
-
-### description
-
-**Type:** String (Read Only)
-
-The the product option value's description
- in the current locale.
-
-### displayValue
-
-**Type:** String (Read Only)
-
-The the product option value's display name
- in the current locale.
-
-### ID
-
-**Type:** String (Read Only)
-
-The product option value's ID.
-
-### productIDModifier
-
-**Type:** String (Read Only)
-
-The product option value's product ID modifier which
- can be used to build the SKU for the actual product.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the the product option value's description in the current locale.
-
-### getDisplayValue
-
-**Signature:** `getDisplayValue() : String`
-
-Returns the the product option value's display name in the current locale.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the product option value's ID.
-
-### getProductIDModifier
-
-**Signature:** `getProductIDModifier() : String`
-
-Returns the product option value's product ID modifier which can be used to build the SKU for the actual product.
-
-## Method Detail
-
-## Method Details
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the the product option value's description in the current locale.
-
-**Returns:**
-
-The value of the product option value's description in the current locale, or null if it wasn't found.
-
----
-
-### getDisplayValue
-
-**Signature:** `getDisplayValue() : String`
-
-**Description:** Returns the the product option value's display name in the current locale.
-
-**Returns:**
-
-The value of the product option value's display name in the current locale, or null if it wasn't found.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the product option value's ID.
-
-**Returns:**
-
-the product option value's ID.
-
----
-
-### getProductIDModifier
-
-**Signature:** `getProductIDModifier() : String`
-
-**Description:** Returns the product option value's product ID modifier which can be used to build the SKU for the actual product.
-
-**Returns:**
-
-the product option value's product ID modifier which can be used to build the SKU for the actual product.
-
----