sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_web/PagingModel.md

@@ -1,389 +0,0 @@
-## Package: dw.web
-
-# Class PagingModel
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.PagingModel
-
-## Description
-
-A page model is a helper class to apply a pages to a collection of elements or an iterator of elements and supports creating URLs for continued paging through the elements. The page model is intended to be initialized with the collection or iterator, than the paging position is applyed and than the elements are extracted with getPageElements(). In case the page model is initialized with a collection the page model can be reused multiple times.
-
-## Constants
-
-### DEFAULT_PAGE_SIZE
-
-**Type:** Number = 10
-
-The default page size.
-
-### MAX_PAGE_SIZE
-
-**Type:** Number = 2000
-
-The maximum supported page size.
-
-### PAGING_SIZE_PARAMETER
-
-**Type:** String = "sz"
-
-The URL Parameter used for the page size.
-
-### PAGING_START_PARAMETER
-
-**Type:** String = "start"
-
-The URL parameter used for the start position.
-
-## Properties
-
-### count
-
-**Type:** Number (Read Only)
-
-The count of the number of items in the model.
-
-### currentPage
-
-**Type:** Number (Read Only)
-
-The index number of the current page. The page
- counting starts with 0. The method also works with a miss-aligned
- start. In that case the start is always treated as the start of
- a page.
-
-### empty
-
-**Type:** boolean (Read Only)
-
-Identifies if the model is empty.
-
-### end
-
-**Type:** Number (Read Only)
-
-The index of the last element on the current page.
-
-### maxPage
-
-**Type:** Number (Read Only)
-
-The maximum possible page number. Counting for pages starts
- with 0.  The method also works with a miss-aligned start. In that case
- the returned number might be higher than ((count-1) / pageSize).
-
-### pageCount
-
-**Type:** Number (Read Only)
-
-The total page count. The method also works
- with a miss-aligned start. In that case the returned number might
- be higher than (count / pageSize).
-
-### pageElements
-
-**Type:** Iterator (Read Only)
-
-An iterator that can be used to iterate through the elements of
- the current page.
-
- In case of a collection as the page models source, the method can be
- called multiple times. Each time a fresh iterator is returned.
-
- In case of an iterator as the page models source, the method must be
- called only once. The method will always return the same iterator,
- which means the method amy return an exhausted iterator.
-
-### pageSize
-
-**Type:** Number
-
-The size of the page.
-
-### start
-
-**Type:** Number
-
-The current start position from which iteration will start.
-
-## Constructor Summary
-
-PagingModel(elements : Iterator, count : Number) Constructs the PagingModel using the specified iterator and count value.
-
-PagingModel(elements : Collection) Constructs the PagingModel using the specified collection.
-
-## Method Summary
-
-### appendPageSize
-
-**Signature:** `static appendPageSize(url : URL, pageSize : Number) : URL`
-
-Returns an URL containing the page size parameter appended to the specified url.
-
-### appendPaging
-
-**Signature:** `appendPaging(url : URL) : URL`
-
-Returns an URL by appending the current page start position and the current page size to the URL.
-
-### appendPaging
-
-**Signature:** `appendPaging(url : URL, position : Number) : URL`
-
-Returns an URL by appending the paging parameters for a desired page start position and the current page size to the specified url.
-
-### getCount
-
-**Signature:** `getCount() : Number`
-
-Returns the count of the number of items in the model.
-
-### getCurrentPage
-
-**Signature:** `getCurrentPage() : Number`
-
-Returns the index number of the current page.
-
-### getEnd
-
-**Signature:** `getEnd() : Number`
-
-Returns the index of the last element on the current page.
-
-### getMaxPage
-
-**Signature:** `getMaxPage() : Number`
-
-Returns the maximum possible page number.
-
-### getPageCount
-
-**Signature:** `getPageCount() : Number`
-
-Returns the total page count.
-
-### getPageElements
-
-**Signature:** `getPageElements() : Iterator`
-
-Returns an iterator that can be used to iterate through the elements of the current page.
-
-### getPageSize
-
-**Signature:** `getPageSize() : Number`
-
-Returns the size of the page.
-
-### getStart
-
-**Signature:** `getStart() : Number`
-
-Returns the current start position from which iteration will start.
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-Identifies if the model is empty.
-
-### setPageSize
-
-**Signature:** `setPageSize(pageSize : Number) : void`
-
-Sets the size of the page.
-
-### setStart
-
-**Signature:** `setStart(start : Number) : void`
-
-Sets the current start position from which iteration will start.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### appendPageSize
-
-**Signature:** `static appendPageSize(url : URL, pageSize : Number) : URL`
-
-**Description:** Returns an URL containing the page size parameter appended to the specified url. The name of the page size parameter is 'sz' (see PAGE_SIZE_PARAMETER). The start position parameter is not appended to the returned URL.
-
-**Parameters:**
-
-- `url`: the URL to append the page size parameter to.
-- `pageSize`: the page size
-
-**Returns:**
-
-an URL that contains the page size parameter.
-
----
-
-### appendPaging
-
-**Signature:** `appendPaging(url : URL) : URL`
-
-**Description:** Returns an URL by appending the current page start position and the current page size to the URL.
-
-**Parameters:**
-
-- `url`: the URL to append the current paging position to.
-
-**Returns:**
-
-an URL containing the current paging position.
-
----
-
-### appendPaging
-
-**Signature:** `appendPaging(url : URL, position : Number) : URL`
-
-**Description:** Returns an URL by appending the paging parameters for a desired page start position and the current page size to the specified url. The name of the page start position parameter is 'start' (see PAGING_START_PARAMETER) and the page size parameter is 'sz' (see PAGE_SIZE_PARAMETER).
-
-**Parameters:**
-
-- `url`: the URL to append the paging parameter to.
-- `position`: the start position.
-
-**Returns:**
-
-an URL that contains the paging parameters.
-
----
-
-### getCount
-
-**Signature:** `getCount() : Number`
-
-**Description:** Returns the count of the number of items in the model.
-
-**Returns:**
-
-the count of the number of items in the model.
-
----
-
-### getCurrentPage
-
-**Signature:** `getCurrentPage() : Number`
-
-**Description:** Returns the index number of the current page. The page counting starts with 0. The method also works with a miss-aligned start. In that case the start is always treated as the start of a page.
-
-**Returns:**
-
-the index number of the current page.
-
----
-
-### getEnd
-
-**Signature:** `getEnd() : Number`
-
-**Description:** Returns the index of the last element on the current page.
-
-**Returns:**
-
-the index of the last element on the current page.
-
----
-
-### getMaxPage
-
-**Signature:** `getMaxPage() : Number`
-
-**Description:** Returns the maximum possible page number. Counting for pages starts with 0. The method also works with a miss-aligned start. In that case the returned number might be higher than ((count-1) / pageSize).
-
-**Returns:**
-
-the maximum possible page number.
-
----
-
-### getPageCount
-
-**Signature:** `getPageCount() : Number`
-
-**Description:** Returns the total page count. The method also works with a miss-aligned start. In that case the returned number might be higher than (count / pageSize).
-
-**Returns:**
-
-the total page count.
-
----
-
-### getPageElements
-
-**Signature:** `getPageElements() : Iterator`
-
-**Description:** Returns an iterator that can be used to iterate through the elements of the current page. In case of a collection as the page models source, the method can be called multiple times. Each time a fresh iterator is returned. In case of an iterator as the page models source, the method must be called only once. The method will always return the same iterator, which means the method amy return an exhausted iterator.
-
-**Returns:**
-
-an iterator that you use to iterate through the elements of the current page.
-
----
-
-### getPageSize
-
-**Signature:** `getPageSize() : Number`
-
-**Description:** Returns the size of the page.
-
-**Returns:**
-
-the size of the page.
-
----
-
-### getStart
-
-**Signature:** `getStart() : Number`
-
-**Description:** Returns the current start position from which iteration will start.
-
-**Returns:**
-
-the current start position from which iteration will start.
-
----
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-**Description:** Identifies if the model is empty.
-
-**Returns:**
-
-true if the model is empty, false otherwise.
-
----
-
-### setPageSize
-
-**Signature:** `setPageSize(pageSize : Number) : void`
-
-**Description:** Sets the size of the page. The page size must be greater or equal to 1.
-
-**Parameters:**
-
-- `pageSize`: the size of the page.
-
----
-
-### setStart
-
-**Signature:** `setStart(start : Number) : void`
-
-**Description:** Sets the current start position from which iteration will start.
-
-**Parameters:**
-
-- `start`: the current start position from which iteration will start.
-
----

package/docs/dw_web/Resource.md

@@ -1,126 +0,0 @@
-## Package: dw.web
-
-# Class Resource
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.Resource
-
-## Description
-
-Library class which provides methods for retrieving messages from properties resource bundles which contain locale-specific strings. When your program needs a locale-specific String, it loads it from the resource bundle that is appropriate for the user's current locale. In this way, the program code is largely independent of the user's locale. In Commerce Cloud Digital, resources are associated with the templates of a cartridge. These bundles consist of properties files with a common name defined in the template/resources directory of a site cartridge. For example: templates/resources/message.properties templates/resources/message_en.properties templates/resources/message_en_US.properties templates/resources/message_de_DE.properties Resource bundle lookup generally follows the same rules as the Java ResourceBundle class, where the locale used for lookup is based on the current request. See method javadoc for additional details. Properties resource files are assumed to use the UTF-8 character encoding. Unicode escape sequences are also supported.
-
-## Constructor Summary
-
-## Method Summary
-
-### msg
-
-**Signature:** `static msg(key : String) : String`
-
-Returns the message from the default properties resource bundle (base name "message") corresponding to the specified key and the request locale.
-
-### msg
-
-**Signature:** `static msg(key : String, defaultMessage : String) : String`
-
-Returns the message from the default properties resource bundle (base name "message") corresponding to the specified key and the request locale.
-
-### msg
-
-**Signature:** `static msg(key : String, bundleName : String, defaultMessage : String) : String`
-
-Returns the message from the specified properties resource bundle.
-
-### msgf
-
-**Signature:** `static msgf(key : String, bundleName : String, defaultMessage : String, args : Object...) : String`
-
-Returns the message from the specified properties resource bundle, with the provided arguments substituted for the message argument placeholders (specified using the Java MessageFormat approach).
-
-## Method Detail
-
-## Method Details
-
-### msg
-
-**Signature:** `static msg(key : String) : String`
-
-**Description:** Returns the message from the default properties resource bundle (base name "message") corresponding to the specified key and the request locale. This method is equivalent to msg(String, null).
-
-**Parameters:**
-
-- `key`: resource bundle message key
-
-**Returns:**
-
-the resource bundle message or the key itself if no message is defined.
-
-**See Also:**
-
-msg(String, String)
-
----
-
-### msg
-
-**Signature:** `static msg(key : String, defaultMessage : String) : String`
-
-**Description:** Returns the message from the default properties resource bundle (base name "message") corresponding to the specified key and the request locale. If no message for the key is found, returns the default message if it is not null, otherwise returns the key itself. This method is equivalent to msg(key, null, defaultMessage).
-
-**Parameters:**
-
-- `key`: resource bundle message key
-- `defaultMessage`: default message to return if no message corresponding to the key is found
-
-**Returns:**
-
-the resource bundle message or default message
-
-**See Also:**
-
-msg(String, String, String)
-
----
-
-### msg
-
-**Signature:** `static msg(key : String, bundleName : String, defaultMessage : String) : String`
-
-**Description:** Returns the message from the specified properties resource bundle. The resource bundle is located by iterating the site cartridges and looking for a bundle with the specified name in the cartridge template/resources directory. If it finds a bundle, it tries to return a message from the bundle using standard Java ResourceBundle logic. If a message is found in that cartridge's bundle, it is returned, otherwise, the next cartridge is examined. The method throws an exception if the key is null.
-
-**Parameters:**
-
-- `key`: resource bundle message key
-- `bundleName`: base bundle name, if null, default bundle name, "message", is used
-- `defaultMessage`: default message to return if no message corresponding to the key is found and defaultMessage is not null
-
-**Returns:**
-
-the resource bundle message or default message
-
----
-
-### msgf
-
-**Signature:** `static msgf(key : String, bundleName : String, defaultMessage : String, args : Object...) : String`
-
-**Description:** Returns the message from the specified properties resource bundle, with the provided arguments substituted for the message argument placeholders (specified using the Java MessageFormat approach). If null is passed for the varargs argument, this method is equivalent to msg(key, bundleName, defaultMessage).
-
-**Parameters:**
-
-- `key`: resource bundle message key
-- `bundleName`: base bundle name, if null, default bundle name, "message", is used
-- `defaultMessage`: default message to return if no message corresponding to the key is found and defaultMessage is not null
-- `args`: optional list of arguments or a collection, which are included into the result string
-
-**Returns:**
-
-the resource bundle message or default message
-
-**See Also:**
-
-msg(String, String, String)
-
----

package/docs/dw_web/URL.md

@@ -1,213 +0,0 @@
-## Package: dw.web
-
-# Class URL
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.URL
-
-## Description
-
-Represents a URL in Commerce Cloud Digital.
-
-## Constructor Summary
-
-## Method Summary
-
-### abs
-
-**Signature:** `abs() : URL`
-
-Makes the URL absolute and ensures that the protocol of the request is used or http in a mail context.
-
-### append
-
-**Signature:** `append(name : String, value : String) : URL`
-
-Append a request parameter to this URL.
-
-### appendCSRFTokenBM
-
-**Signature:** `appendCSRFTokenBM() : URL`
-
-Appends, if applicable, a CSRF protection token to this URL.
-
-### host
-
-**Signature:** `host(host : String) : URL`
-
-Updates the URL with the specified host name Note: This method is not applicable for static content or image transformation URLs.
-
-### http
-
-**Signature:** `http() : URL`
-
-Makes the URL absolute and ensures that the protocol http is used.
-
-### https
-
-**Signature:** `https() : URL`
-
-Makes the URL absolute and ensures that the protocol https is used.
-
-### relative
-
-**Signature:** `relative() : URL`
-
-Makes the URL relative.
-
-### remove
-
-**Signature:** `remove(name : String) : URL`
-
-Remove a request parameter from this URL.
-
-### siteHost
-
-**Signature:** `siteHost() : URL`
-
-Updates the URL with the site host name Note: This method is not applicable for static content or image transformation URLs.
-
-### toString
-
-**Signature:** `toString() : String`
-
-Return String representation of the URL.
-
-## Method Detail
-
-## Method Details
-
-### abs
-
-**Signature:** `abs() : URL`
-
-**Description:** Makes the URL absolute and ensures that the protocol of the request is used or http in a mail context. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### append
-
-**Signature:** `append(name : String, value : String) : URL`
-
-**Description:** Append a request parameter to this URL.
-
-**Parameters:**
-
-- `name`: The parameter name. Must not be null.
-- `value`: The parameter value. If null, then treated as empty value.
-
-**Returns:**
-
-A reference to this URL.
-
----
-
-### appendCSRFTokenBM
-
-**Signature:** `appendCSRFTokenBM() : URL`
-
-**Description:** Appends, if applicable, a CSRF protection token to this URL. The CSRF token will only be appended under the following conditions: the URL is a pipeline URL the URL is for Business Manager If a CSRF token already exists in the URL, it will be replaced with a newly generated one.
-
-**Returns:**
-
-a reference to this URL, with a CSRF token appended if applicable.
-
----
-
-### host
-
-**Signature:** `host(host : String) : URL`
-
-**Description:** Updates the URL with the specified host name Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Parameters:**
-
-- `host`: The host name that is used to update the URL.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### http
-
-**Signature:** `http() : URL`
-
-**Description:** Makes the URL absolute and ensures that the protocol http is used. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### https
-
-**Signature:** `https() : URL`
-
-**Description:** Makes the URL absolute and ensures that the protocol https is used. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### relative
-
-**Signature:** `relative() : URL`
-
-**Description:** Makes the URL relative. Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### remove
-
-**Signature:** `remove(name : String) : URL`
-
-**Description:** Remove a request parameter from this URL. If the parameter is not part of the URL, nothing is done.
-
-**Parameters:**
-
-- `name`: The parameter name. Must not be null.
-
-**Returns:**
-
-A reference to this URL.
-
----
-
-### siteHost
-
-**Signature:** `siteHost() : URL`
-
-**Description:** Updates the URL with the site host name Note: This method is not applicable for static content or image transformation URLs. In this case a runtime exception is thrown.
-
-**Returns:**
-
-A new URL instance.
-
----
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Return String representation of the URL.
-
-**Returns:**
-
-the URL as a string.
-
----