sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_system/System.md

@@ -1,200 +0,0 @@
-## Package: dw.system
-
-# Class System
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.System
-
-## Description
-
-Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types, "development system", "staging system" or "production system".
-
-## Constants
-
-### DEVELOPMENT_SYSTEM
-
-**Type:** Number = 0
-
-Represents the development system.
-
-### PRODUCTION_SYSTEM
-
-**Type:** Number = 2
-
-Represents the production system.
-
-### STAGING_SYSTEM
-
-**Type:** Number = 1
-
-Represents the staging system.
-
-## Properties
-
-### calendar
-
-**Type:** Calendar (Read Only)
-
-A new Calendar object in the time zone of the
- current instance.
-
-### compatibilityMode
-
-**Type:** Number (Read Only)
-
-The compatibility mode of the custom code version that is currently active. The compatibility mode is
- returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
-
-### instanceHostname
-
-**Type:** String (Read Only)
-
-Returns instance hostname.
-
-### instanceTimeZone
-
-**Type:** String (Read Only)
-
-The instance time zone. The instance time zone is the time zone in which global actions like jobs or
- reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.
- Changes will affect only new sessions.
-
-### instanceType
-
-**Type:** Number (Read Only)
-
-The type of the instance. An application server instance is configured to be of one of three types,
- "development system", "staging system" or "production system".
- This method returns a constant representing the instance type of this
- application server.
-
-### preferences
-
-**Type:** OrganizationPreferences (Read Only)
-
-This method returns a container of all global preferences of this
- organization (instance).
-
-## Constructor Summary
-
-## Method Summary
-
-### getCalendar
-
-**Signature:** `static getCalendar() : Calendar`
-
-Returns a new Calendar object in the time zone of the current instance.
-
-### getCompatibilityMode
-
-**Signature:** `static getCompatibilityMode() : Number`
-
-Returns the compatibility mode of the custom code version that is currently active.
-
-### getInstanceHostname
-
-**Signature:** `static getInstanceHostname() : String`
-
-Returns instance hostname.
-
-### getInstanceTimeZone
-
-**Signature:** `static getInstanceTimeZone() : String`
-
-Returns the instance time zone.
-
-### getInstanceType
-
-**Signature:** `static getInstanceType() : Number`
-
-Returns the type of the instance.
-
-### getPreferences
-
-**Signature:** `static getPreferences() : OrganizationPreferences`
-
-This method returns a container of all global preferences of this organization (instance).
-
-## Method Detail
-
-## Method Details
-
-### getCalendar
-
-**Signature:** `static getCalendar() : Calendar`
-
-**Description:** Returns a new Calendar object in the time zone of the current instance.
-
-**Returns:**
-
-a Calendar object in the time zone of the instance.
-
----
-
-### getCompatibilityMode
-
-**Signature:** `static getCompatibilityMode() : Number`
-
-**Description:** Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
-
-**Returns:**
-
-The currently active compatibility mode.
-
----
-
-### getInstanceHostname
-
-**Signature:** `static getInstanceHostname() : String`
-
-**Description:** Returns instance hostname.
-
-**Returns:**
-
-instance hostname.
-
----
-
-### getInstanceTimeZone
-
-**Signature:** `static getInstanceTimeZone() : String`
-
-**Description:** Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session. Changes will affect only new sessions.
-
-**Returns:**
-
-the instance time zone.
-
----
-
-### getInstanceType
-
-**Signature:** `static getInstanceType() : Number`
-
-**Description:** Returns the type of the instance. An application server instance is configured to be of one of three types, "development system", "staging system" or "production system". This method returns a constant representing the instance type of this application server.
-
-**Returns:**
-
-the instance type of the application server where this method was called.
-
-**See Also:**
-
-DEVELOPMENT_SYSTEM
-PRODUCTION_SYSTEM
-STAGING_SYSTEM
-
----
-
-### getPreferences
-
-**Signature:** `static getPreferences() : OrganizationPreferences`
-
-**Description:** This method returns a container of all global preferences of this organization (instance).
-
-**Returns:**
-
-a preferences object containing all global system and custom preferences of this instance
-
----

package/docs/dw_system/Transaction.md

@@ -1,84 +0,0 @@
-## Package: dw.system
-
-# Class Transaction
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.Transaction
-
-## Description
-
-Represents the current transaction. A transaction provides a context for performing atomic changes to persistent business objects. Before a business object can be created, changed, or deleted, a transaction must be started using the begin() method. All changes on the touched business objects will only be made durable when the transaction is committed with commit(). If a transaction is rolled back, all changes so far will be reverted and the business object will have their previous state again. It is possible to begin a transaction multiple times in a nested way (like begin-begin-commit-commit). In this case, in order to commit the changes the commit method must be called symmetrically as often as begin. It is also possible to run multiple transactions within a single request, one after another (like begin-commit-begin-commit). In case of any exception while working with business objects inside of a transaction, the transaction cannot be committed anymore, but only be rolled back. Business code may try to take appropriate actions if it expects business-related problems at commit (for example, constraint violations). When a transaction is still open at the end of a pipeline call, controller call, or job step, the remaining changes are committed unless an exception is thrown. The following best practices exist for using transactions: Avoid long running transactions in jobs. Use one transaction for changes that belong together and need a joint rollback. In most cases, one transaction for all changes in a request is better than multiple transactions for each individual object. Don’t begin and commit a huge number of small transactions in a loop. Avoid changing the same objects in parallel transactions. Example 1 - explicit control: var txn = require('dw/system/Transaction'); txn.begin(); // work with business objects here txn.commit(); Example 2 - implicit control: var txn = require('dw/system/Transaction'); txn.wrap(function(){ // work with business objects here });
-
-## Constructor Summary
-
-## Method Summary
-
-### begin
-
-**Signature:** `static begin() : void`
-
-Begins a transaction.
-
-### commit
-
-**Signature:** `static commit() : void`
-
-Commits the current transaction.
-
-### rollback
-
-**Signature:** `static rollback() : void`
-
-Rolls back the current transaction.
-
-### wrap
-
-**Signature:** `static wrap(callback : Function) : Object`
-
-Encloses the provided callback function in a begin-commit transactional context.
-
-## Method Detail
-
-## Method Details
-
-### begin
-
-**Signature:** `static begin() : void`
-
-**Description:** Begins a transaction.
-
----
-
-### commit
-
-**Signature:** `static commit() : void`
-
-**Description:** Commits the current transaction. The transaction must have been started with begin() before.
-
----
-
-### rollback
-
-**Signature:** `static rollback() : void`
-
-**Description:** Rolls back the current transaction. The transaction must have been started with begin() before.
-
----
-
-### wrap
-
-**Signature:** `static wrap(callback : Function) : Object`
-
-**Description:** Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be committed successfully, it is rolled back instead and an exception is thrown.
-
-**Parameters:**
-
-- `callback`: a function that should be executed within a transactional context
-
-**Returns:**
-
-the result of the callback function, if it returns something
-
----

package/docs/dw_util/ArrayList.md

@@ -1,50 +0,0 @@
-## Package: dw.util
-
-# Class ArrayList
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Collection
-  - dw.util.List
-    - dw.util.ArrayList
-
-## Description
-
-The ArrayList class is a container for a list of objects.
-
-## Constructor Summary
-
-ArrayList() Constructor for a new ArrayList.
-
-ArrayList(collection : Collection) Constructor for a new ArrayList.
-
-ArrayList(iterator : Iterator) Constructor for a new ArrayList.
-
-ArrayList(values : Object...) Constructor for a new ArrayList.
-
-## Method Summary
-
-### clone
-
-**Signature:** `clone() : ArrayList`
-
-Returns a shallow copy of this array list.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### clone
-
-**Signature:** `clone() : ArrayList`
-
-**Description:** Returns a shallow copy of this array list.
-
-**Returns:**
-
-a shallow copy of this array list.
-
----

package/docs/dw_util/Assert.md

@@ -1,391 +0,0 @@
-## Package: dw.util
-
-# Class Assert
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Assert
-
-## Description
-
-The Assert class provides utility methods for assertion events.
-
-## Constructor Summary
-
-## Method Summary
-
-### areEqual
-
-**Signature:** `static areEqual(arg1 : Object, arg2 : Object) : void`
-
-Propagates an assertion if the specified objects are not equal.
-
-### areEqual
-
-**Signature:** `static areEqual(arg1 : Object, arg2 : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified objects are not equal.
-
-### areSame
-
-**Signature:** `static areSame(arg1 : Object, arg2 : Object) : void`
-
-Propagates an assertion if the specified objects are not the same.
-
-### areSame
-
-**Signature:** `static areSame(arg1 : Object, arg2 : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified objects are not the same.
-
-### fail
-
-**Signature:** `static fail() : void`
-
-Propagates a failure assertion.
-
-### fail
-
-**Signature:** `static fail(msg : String) : void`
-
-Propagates a failure assertion using the specified message.
-
-### isEmpty
-
-**Signature:** `static isEmpty(arg : Object) : void`
-
-Propagates an assertion if the specified check does not evaluate to an empty object.
-
-### isEmpty
-
-**Signature:** `static isEmpty(arg : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.
-
-### isFalse
-
-**Signature:** `static isFalse(check : boolean) : void`
-
-Propagates an assertion if the specified check does not evaluate to false.
-
-### isFalse
-
-**Signature:** `static isFalse(check : boolean, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified check does not evaluate to false.
-
-### isInstanceOf
-
-**Signature:** `static isInstanceOf(clazz : Object, arg : Object) : void`
-
-Propagates an assertion if the specified object 'arg' is not an instance of the specified class 'clazz'.
-
-### isInstanceOf
-
-**Signature:** `static isInstanceOf(clazz : Object, arg : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified object is not an instance of the specified class.
-
-### isNotEmpty
-
-**Signature:** `static isNotEmpty(arg : Object) : void`
-
-Propagates an assertion if the specified object is empty.
-
-### isNotEmpty
-
-**Signature:** `static isNotEmpty(arg : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified object is empty.
-
-### isNotNull
-
-**Signature:** `static isNotNull(arg : Object) : void`
-
-Propagates an assertion if the specified object is null.
-
-### isNotNull
-
-**Signature:** `static isNotNull(arg : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified object is null.
-
-### isNull
-
-**Signature:** `static isNull(arg : Object) : void`
-
-Propagates an assertion if the specified object is not null.
-
-### isNull
-
-**Signature:** `static isNull(arg : Object, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified object is not null.
-
-### isTrue
-
-**Signature:** `static isTrue(check : boolean) : void`
-
-Propagates an assertion if the specified check does not evaluate to true.
-
-### isTrue
-
-**Signature:** `static isTrue(check : boolean, msg : String) : void`
-
-Propagates an assertion using the specified message if the specified check does not evaluate to true.
-
-## Method Detail
-
-## Method Details
-
-### areEqual
-
-**Signature:** `static areEqual(arg1 : Object, arg2 : Object) : void`
-
-**Description:** Propagates an assertion if the specified objects are not equal.
-
-**Parameters:**
-
-- `arg1`: the first object to check.
-- `arg2`: the second object to check.
-
----
-
-### areEqual
-
-**Signature:** `static areEqual(arg1 : Object, arg2 : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified objects are not equal.
-
-**Parameters:**
-
-- `arg1`: the first object to check.
-- `arg2`: the second object to check.
-- `msg`: the assertion message.
-
----
-
-### areSame
-
-**Signature:** `static areSame(arg1 : Object, arg2 : Object) : void`
-
-**Description:** Propagates an assertion if the specified objects are not the same.
-
-**Parameters:**
-
-- `arg1`: the first object to check.
-- `arg2`: the second object to check.
-
----
-
-### areSame
-
-**Signature:** `static areSame(arg1 : Object, arg2 : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified objects are not the same.
-
-**Parameters:**
-
-- `arg1`: the first object to check.
-- `arg2`: the second object to check.
-- `msg`: the assertion message.
-
----
-
-### fail
-
-**Signature:** `static fail() : void`
-
-**Description:** Propagates a failure assertion.
-
----
-
-### fail
-
-**Signature:** `static fail(msg : String) : void`
-
-**Description:** Propagates a failure assertion using the specified message.
-
-**Parameters:**
-
-- `msg`: the assertion message.
-
----
-
-### isEmpty
-
-**Signature:** `static isEmpty(arg : Object) : void`
-
-**Description:** Propagates an assertion if the specified check does not evaluate to an empty object.
-
-**Parameters:**
-
-- `arg`: the object to check.
-
----
-
-### isEmpty
-
-**Signature:** `static isEmpty(arg : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified check does not evaluate to an empty object.
-
-**Parameters:**
-
-- `arg`: the object to check.
-- `msg`: the assertion message.
-
----
-
-### isFalse
-
-**Signature:** `static isFalse(check : boolean) : void`
-
-**Description:** Propagates an assertion if the specified check does not evaluate to false.
-
-**Parameters:**
-
-- `check`: the condition to check.
-
----
-
-### isFalse
-
-**Signature:** `static isFalse(check : boolean, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified check does not evaluate to false.
-
-**Parameters:**
-
-- `check`: the condition to check.
-- `msg`: the assertion message.
-
----
-
-### isInstanceOf
-
-**Signature:** `static isInstanceOf(clazz : Object, arg : Object) : void`
-
-**Description:** Propagates an assertion if the specified object 'arg' is not an instance of the specified class 'clazz'. For example, the following call does not propagate an assertion: var test = new dw.util.HashMap(); dw.util.Assert.isInstanceOf(dw.util.HashMap, test); But the following call will propagate an assertion: var test = new dw.util.Set(); dw.util.Assert.isInstanceOf(dw.util.HashMap, test); Note that 'clazz' can only be a Demandware API Scripting class.
-
-**Parameters:**
-
-- `clazz`: the scripting class to use to check the object.
-- `arg`: the object to check.
-
----
-
-### isInstanceOf
-
-**Signature:** `static isInstanceOf(clazz : Object, arg : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified object is not an instance of the specified class. For example, the following call does not propagate an assertion: var test = new dw.util.HashMap(); dw.util.Assert.isInstanceOf(dw.util.HashMap, test); But the following call will propagate an assertion: var test = new dw.util.Set(); dw.util.Assert.isInstanceOf(dw.util.HashMap, test); Note that 'clazz' can only be a Demandware API Scripting class.
-
-**Parameters:**
-
-- `clazz`: the scripting class to use to check the object.
-- `arg`: the object to check.
-- `msg`: the assertion message.
-
----
-
-### isNotEmpty
-
-**Signature:** `static isNotEmpty(arg : Object) : void`
-
-**Description:** Propagates an assertion if the specified object is empty.
-
-**Parameters:**
-
-- `arg`: the object to check.
-
----
-
-### isNotEmpty
-
-**Signature:** `static isNotEmpty(arg : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified object is empty.
-
-**Parameters:**
-
-- `arg`: the object to check.
-- `msg`: the assertion message.
-
----
-
-### isNotNull
-
-**Signature:** `static isNotNull(arg : Object) : void`
-
-**Description:** Propagates an assertion if the specified object is null.
-
-**Parameters:**
-
-- `arg`: the object to check.
-
----
-
-### isNotNull
-
-**Signature:** `static isNotNull(arg : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified object is null.
-
-**Parameters:**
-
-- `arg`: the object to check.
-- `msg`: the assertion message.
-
----
-
-### isNull
-
-**Signature:** `static isNull(arg : Object) : void`
-
-**Description:** Propagates an assertion if the specified object is not null.
-
-**Parameters:**
-
-- `arg`: the object to check.
-
----
-
-### isNull
-
-**Signature:** `static isNull(arg : Object, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified object is not null.
-
-**Parameters:**
-
-- `arg`: the object to check.
-- `msg`: the assertion message.
-
----
-
-### isTrue
-
-**Signature:** `static isTrue(check : boolean) : void`
-
-**Description:** Propagates an assertion if the specified check does not evaluate to true.
-
-**Parameters:**
-
-- `check`: the condition to check.
-
----
-
-### isTrue
-
-**Signature:** `static isTrue(check : boolean, msg : String) : void`
-
-**Description:** Propagates an assertion using the specified message if the specified check does not evaluate to true.
-
-**Parameters:**
-
-- `check`: the condition to check.
-- `msg`: the assertion message.
-
----