sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_util/Locale.md

@@ -1,267 +0,0 @@
-## Package: dw.util
-
-# Class Locale
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Locale
-
-## Description
-
-Represents a Locale supported by the system.
-
-## Properties
-
-### country
-
-**Type:** String (Read Only)
-
-The uppercase ISO 3166 2-letter country/region code for this Locale.
- If no country has been specified for this Locale, this value is an empty string.
-
-### displayCountry
-
-**Type:** String (Read Only)
-
-The display name of this Locale's country, in this Locale's language,
- not in the session locale's language.
- If no country has been specified for this Locale, this value is an empty string.
-
-### displayLanguage
-
-**Type:** String (Read Only)
-
-The display name of this Locale's language, in this Locale's language,
- not in the session locale's language.
- If no country has been specified for this Locale, this value is an empty string.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name of this Locale, in this Locale's language,
- not in the session locale's language.
- If no display name has been specified for this Locale, this value is an empty string.
-
-### ID
-
-**Type:** String (Read Only)
-
-The String representation of the localeID.
- 
- Combines the language and the country key, concatenated with "_". 
- For example: "en_US". This attribute is the primary key of the class.
-
-### ISO3Country
-
-**Type:** String (Read Only)
-
-The uppercase ISO 3166 3-letter country/region code for this Locale.
- If no country has been specified for this Locale, this value is an empty string.
-
-### ISO3Language
-
-**Type:** String (Read Only)
-
-The 3-letter ISO 639 language code for this Locale.
- If no language has been specified for this Locale, this value is an empty string.
-
-### language
-
-**Type:** String (Read Only)
-
-The lowercase ISO 639 language code for this Locale.
- If no language has been specified for this Locale, this value is an empty string.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCountry
-
-**Signature:** `getCountry() : String`
-
-Returns the uppercase ISO 3166 2-letter country/region code for this Locale.
-
-### getDisplayCountry
-
-**Signature:** `getDisplayCountry() : String`
-
-Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language.
-
-### getDisplayLanguage
-
-**Signature:** `getDisplayLanguage() : String`
-
-Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name of this Locale, in this Locale's language, not in the session locale's language.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the String representation of the localeID.
-
-### getISO3Country
-
-**Signature:** `getISO3Country() : String`
-
-Returns the uppercase ISO 3166 3-letter country/region code for this Locale.
-
-### getISO3Language
-
-**Signature:** `getISO3Language() : String`
-
-Returns the 3-letter ISO 639 language code for this Locale.
-
-### getLanguage
-
-**Signature:** `getLanguage() : String`
-
-Returns the lowercase ISO 639 language code for this Locale.
-
-### getLocale
-
-**Signature:** `static getLocale(localeId : String) : Locale`
-
-Returns a Locale instance for the given localeId, or null if no such Locale could be found.
-
-### toString
-
-**Signature:** `toString() : String`
-
-Returns the String representation of the localeID.
-
-## Method Detail
-
-## Method Details
-
-### getCountry
-
-**Signature:** `getCountry() : String`
-
-**Description:** Returns the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the uppercase ISO 3166 2-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
-
----
-
-### getDisplayCountry
-
-**Signature:** `getDisplayCountry() : String`
-
-**Description:** Returns the display name of this Locale's country, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the display name of this Locale's country, in this Locale's language. If no country has been specified for this Locale, this value is an empty string.
-
----
-
-### getDisplayLanguage
-
-**Signature:** `getDisplayLanguage() : String`
-
-**Description:** Returns the display name of this Locale's language, in this Locale's language, not in the session locale's language. If no country has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the display name of this Locale's language, in this Locale's language. If no language has been specified for this Locale, this value is an empty string.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the display name of this Locale, in this Locale's language, not in the session locale's language. If no display name has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the display name of this Locale, in this Locale's language. If no display name has been specified for this Locale, this value is an empty string.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the String representation of the localeID. Combines the language and the country key, concatenated with "_". For example: "en_US". This attribute is the primary key of the class.
-
-**Returns:**
-
-the String representation of the localeID.
-
----
-
-### getISO3Country
-
-**Signature:** `getISO3Country() : String`
-
-**Description:** Returns the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the uppercase ISO 3166 3-letter country/region code for this Locale. If no country has been specified for this Locale, this value is an empty string.
-
----
-
-### getISO3Language
-
-**Signature:** `getISO3Language() : String`
-
-**Description:** Returns the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the 3-letter ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
-
----
-
-### getLanguage
-
-**Signature:** `getLanguage() : String`
-
-**Description:** Returns the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
-
-**Returns:**
-
-the lowercase ISO 639 language code for this Locale. If no language has been specified for this Locale, this value is an empty string.
-
----
-
-### getLocale
-
-**Signature:** `static getLocale(localeId : String) : Locale`
-
-**Description:** Returns a Locale instance for the given localeId, or null if no such Locale could be found.
-
-**Parameters:**
-
-- `localeId`: the localeID of the desired Locale
-
-**Returns:**
-
-the Locale instance for the given localeId, or null if no such Locale could be found.
-
----
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Returns the String representation of the localeID. Combines the language and the country key, concatenated with "_". For example: "en_US". This attribute is the primary key of the class.
-
-**Returns:**
-
-the String representation of the localeID.
-
----

package/docs/dw_util/Map.md

@@ -1,313 +0,0 @@
-## Package: dw.util
-
-# Class Map
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Map
-
-## Description
-
-Represents a Map of objects.
-
-## Properties
-
-### empty
-
-**Type:** boolean (Read Only)
-
-Identifies if this map is empty.
-
-### length
-
-**Type:** Number (Read Only)
-
-The size of the map. This is a bean attribute method and
- supports the access to the collections
- length similar to a ECMA array, such as 'products.length'.
-
-## Constructor Summary
-
-## Method Summary
-
-### clear
-
-**Signature:** `clear() : void`
-
-Clears the map of all objects.
-
-### containsKey
-
-**Signature:** `containsKey(key : Object) : boolean`
-
-Identifies if this map contains an element identfied by the specified key.
-
-### containsValue
-
-**Signature:** `containsValue(value : Object) : boolean`
-
-Identifies if this map contains an element identfied by the specified value.
-
-### entrySet
-
-**Signature:** `entrySet() : Set`
-
-Returns a set of the map's entries.
-
-### get
-
-**Signature:** `get(key : Object) : Object`
-
-Returns the object associated with the key or null.
-
-### getLength
-
-**Signature:** `getLength() : Number`
-
-REturns the size of the map.
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-Identifies if this map is empty.
-
-### keySet
-
-**Signature:** `keySet() : Set`
-
-Returns a set of the map's keys.
-
-### put
-
-**Signature:** `put(key : Object, value : Object) : Object`
-
-Puts the specified value into the map using the specified key to identify it.
-
-### putAll
-
-**Signature:** `putAll(other : Map) : void`
-
-Copies all of the objects inside the specified map into this map.
-
-### remove
-
-**Signature:** `remove(key : Object) : Object`
-
-Removes the object from the map that is identified by the key.
-
-### size
-
-**Signature:** `size() : Number`
-
-Returns the size of the map.
-
-### values
-
-**Signature:** `values() : Collection`
-
-Returns a collection of the values contained in this map.
-
-### values
-
-**Signature:** `values() : Collection`
-
-Returns a collection of the values contained in this map.
-
-## Method Detail
-
-## Method Details
-
-### clear
-
-**Signature:** `clear() : void`
-
-**Description:** Clears the map of all objects.
-
----
-
-### containsKey
-
-**Signature:** `containsKey(key : Object) : boolean`
-
-**Description:** Identifies if this map contains an element identfied by the specified key.
-
-**Parameters:**
-
-- `key`: the key to use.
-
-**Returns:**
-
-true if this map contains an element whose key is equal to the specified key.
-
----
-
-### containsValue
-
-**Signature:** `containsValue(value : Object) : boolean`
-
-**Description:** Identifies if this map contains an element identfied by the specified value.
-
-**Parameters:**
-
-- `value`: the value to use.
-
-**Returns:**
-
-true if this map contains an element whose value is equal to the specified value.
-
----
-
-### entrySet
-
-**Signature:** `entrySet() : Set`
-
-**Description:** Returns a set of the map's entries. The returned set is actually a view to the entries of this map.
-
-**Returns:**
-
-a set of the map's entries.
-
----
-
-### get
-
-**Signature:** `get(key : Object) : Object`
-
-**Description:** Returns the object associated with the key or null.
-
-**Parameters:**
-
-- `key`: the key to use.
-
-**Returns:**
-
-the object associated with the key or null.
-
----
-
-### getLength
-
-**Signature:** `getLength() : Number`
-
-**Description:** REturns the size of the map. This is a bean attribute method and supports the access to the collections length similar to a ECMA array, such as 'products.length'.
-
-**Returns:**
-
-the number of objects in the map.
-
----
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-**Description:** Identifies if this map is empty.
-
-**Returns:**
-
-true if the map is empty, false otherwise.
-
----
-
-### keySet
-
-**Signature:** `keySet() : Set`
-
-**Description:** Returns a set of the map's keys. The returned set is actually a view to the keys of this map.
-
-**Returns:**
-
-a set of the map's keys.
-
----
-
-### put
-
-**Signature:** `put(key : Object, value : Object) : Object`
-
-**Description:** Puts the specified value into the map using the specified key to identify it.
-
-**Parameters:**
-
-- `key`: the key to use to identify the value.
-- `value`: the object to put into the map.
-
-**Returns:**
-
-previous value associated with specified key, or null if there was no mapping for key.
-
----
-
-### putAll
-
-**Signature:** `putAll(other : Map) : void`
-
-**Description:** Copies all of the objects inside the specified map into this map.
-
-**Parameters:**
-
-- `other`: the map whose contents are copied into this map.
-
----
-
-### remove
-
-**Signature:** `remove(key : Object) : Object`
-
-**Description:** Removes the object from the map that is identified by the key.
-
-**Parameters:**
-
-- `key`: the key that identifies the object to remove.
-
-**Returns:**
-
-the removed object or null.
-
----
-
-### size
-
-**Signature:** `size() : Number`
-
-**Description:** Returns the size of the map.
-
-**Returns:**
-
-the number of objects in the map.
-
----
-
-### values
-
-**Signature:** `values() : Collection`
-
-**Description:** Returns a collection of the values contained in this map.
-
-**API Versioned:**
-
-No longer available as of version 16.1. Returns an independent modifiable collection holding all values.
-
-**Returns:**
-
-a collection of the values contained in this map
-
----
-
-### values
-
-**Signature:** `values() : Collection`
-
-**Description:** Returns a collection of the values contained in this map.
-
-**API Versioned:**
-
-From version 16.1. Returns a view on the values of this map like keySet() and entrySet() do. Former version returned a shallow copy of this.
-
-**Returns:**
-
-a collection of the values contained in this map
-
----

package/docs/dw_util/MapEntry.md

@@ -1,70 +0,0 @@
-## Package: dw.util
-
-# Class MapEntry
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.MapEntry
-
-## Description
-
-The class represent an entry within a Map.
-
-## Properties
-
-### key
-
-**Type:** Object (Read Only)
-
-The entry's key.
-
-### value
-
-**Type:** Object (Read Only)
-
-The entry's value.
-
-## Constructor Summary
-
-## Method Summary
-
-### getKey
-
-**Signature:** `getKey() : Object`
-
-Returns the entry's key.
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-Returns the entry's value.
-
-## Method Detail
-
-## Method Details
-
-### getKey
-
-**Signature:** `getKey() : Object`
-
-**Description:** Returns the entry's key.
-
-**Returns:**
-
-the entry's key.
-
----
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-**Description:** Returns the entry's value.
-
-**Returns:**
-
-the entry's value.
-
----

package/docs/dw_util/MappingKey.md

@@ -1,76 +0,0 @@
-## Package: dw.util
-
-# Class MappingKey
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.MappingKey
-
-## Description
-
-Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a single string (e.g. product id) or multiple string components (e.g. product id and site).
-
-## Properties
-
-### keyComponents
-
-**Type:** String (Read Only)
-
-Gets the (possible compound) key. If the key consists of only of a single value, the string array
- will simply contain a single element.
-
-### singleComponentKey
-
-**Type:** String (Read Only)
-
-Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is
- not a single component key.
-
-## Constructor Summary
-
-MappingKey(keyComponents : String...) Instantiates a new key using compound key components.
-
-## Method Summary
-
-### getKeyComponents
-
-**Signature:** `getKeyComponents() : String[]`
-
-Gets the (possible compound) key.
-
-### getSingleComponentKey
-
-**Signature:** `getSingleComponentKey() : String`
-
-Gets a key that contains only a single key component (i.e.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getKeyComponents
-
-**Signature:** `getKeyComponents() : String[]`
-
-**Description:** Gets the (possible compound) key. If the key consists of only of a single value, the string array will simply contain a single element.
-
-**Returns:**
-
-the key
-
----
-
-### getSingleComponentKey
-
-**Signature:** `getSingleComponentKey() : String`
-
-**Description:** Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is not a single component key.
-
-**Returns:**
-
-the single key
-
----