sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/dw_web/Form.md

@@ -1,74 +0,0 @@
-## Package: dw.web
-
-# Class Form
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-  - dw.web.FormGroup
-    - dw.web.Form
-
-## Description
-
-The class is the top level element in the form instance hierachy.
-
-## Properties
-
-### secureKeyHtmlName
-
-**Type:** String (Read Only)
-
-The secure key html name to be used for the hidden input field
- that will contain the secure key value.
-
-### secureKeyValue
-
-**Type:** String (Read Only)
-
-The secure key value that is generated for the form to use
- in a hidden input field for authentication.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSecureKeyHtmlName
-
-**Signature:** `getSecureKeyHtmlName() : String`
-
-Returns the secure key html name to be used for the hidden input field that will contain the secure key value.
-
-### getSecureKeyValue
-
-**Signature:** `getSecureKeyValue() : String`
-
-Returns the secure key value that is generated for the form to use in a hidden input field for authentication.
-
-## Method Detail
-
-## Method Details
-
-### getSecureKeyHtmlName
-
-**Signature:** `getSecureKeyHtmlName() : String`
-
-**Description:** Returns the secure key html name to be used for the hidden input field that will contain the secure key value.
-
-**Returns:**
-
-the secure key html name
-
----
-
-### getSecureKeyValue
-
-**Signature:** `getSecureKeyValue() : String`
-
-**Description:** Returns the secure key value that is generated for the form to use in a hidden input field for authentication.
-
-**Returns:**
-
-the secure key value
-
----

package/docs/dw_web/FormAction.md

@@ -1,199 +0,0 @@
-## Package: dw.web
-
-# Class FormAction
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-  - dw.web.FormAction
-
-## Description
-
-The FormAction class represents the action in form instance hierarchy.
-
-## Properties
-
-### description
-
-**Type:** String (Read Only)
-
-The optional description for the action. The description could be used
- as tooltip for the action.
-
-### label
-
-**Type:** String (Read Only)
-
-The optional label for the action. The label would be typically used
- as button text.
-
-### object
-
-**Type:** Object (Read Only)
-
-The object that was bound to the form in which the action
- is contained. The method is a convenience method for getParent().getObject().
- In most cases this is actually the object for which
- the specific action is triggered.
-
-### submitted
-
-**Type:** boolean (Read Only)
-
-Identifies if the form action was submitted from
- the client to the server.
-
-### triggered
-
-**Type:** boolean (Read Only)
-
-Identifies that this action is triggerd. An
- action is only triggered if it was submitted and the constraints, regarding
- a valid form, are met.
-
-### x
-
-**Type:** Number (Read Only)
-
-In case of an image button, returns the x coordinate of the last click.
-
-### y
-
-**Type:** Number (Read Only)
-
-In case of an image button, returns the y coordinate of the last click.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the optional description for the action.
-
-### getLabel
-
-**Signature:** `getLabel() : String`
-
-Returns the optional label for the action.
-
-### getObject
-
-**Signature:** `getObject() : Object`
-
-Returns the object that was bound to the form in which the action is contained.
-
-### getX
-
-**Signature:** `getX() : Number`
-
-In case of an image button, returns the x coordinate of the last click.
-
-### getY
-
-**Signature:** `getY() : Number`
-
-In case of an image button, returns the y coordinate of the last click.
-
-### isSubmitted
-
-**Signature:** `isSubmitted() : boolean`
-
-Identifies if the form action was submitted from the client to the server.
-
-### isTriggered
-
-**Signature:** `isTriggered() : boolean`
-
-Identifies that this action is triggerd.
-
-## Method Detail
-
-## Method Details
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the optional description for the action. The description could be used as tooltip for the action.
-
-**Returns:**
-
-the optional description for the action.
-
----
-
-### getLabel
-
-**Signature:** `getLabel() : String`
-
-**Description:** Returns the optional label for the action. The label would be typically used as button text.
-
-**Returns:**
-
-the optional label for the action.
-
----
-
-### getObject
-
-**Signature:** `getObject() : Object`
-
-**Description:** Returns the object that was bound to the form in which the action is contained. The method is a convenience method for getParent().getObject(). In most cases this is actually the object for which the specific action is triggered.
-
-**Returns:**
-
-the object that was bound to the form in which the action is contained.
-
----
-
-### getX
-
-**Signature:** `getX() : Number`
-
-**Description:** In case of an image button, returns the x coordinate of the last click.
-
-**Returns:**
-
-the x coordinate of the last click.
-
----
-
-### getY
-
-**Signature:** `getY() : Number`
-
-**Description:** In case of an image button, returns the y coordinate of the last click.
-
-**Returns:**
-
-the y coordinate of the last click.
-
----
-
-### isSubmitted
-
-**Signature:** `isSubmitted() : boolean`
-
-**Description:** Identifies if the form action was submitted from the client to the server.
-
-**Returns:**
-
-true if the form action was submitted, false otherwise.
-
----
-
-### isTriggered
-
-**Signature:** `isTriggered() : boolean`
-
-**Description:** Identifies that this action is triggerd. An action is only triggered if it was submitted and the constraints, regarding a valid form, are met.
-
-**Returns:**
-
-true if the action is triggered, false otherwise.
-
----

package/docs/dw_web/FormElement.md

@@ -1,220 +0,0 @@
-## Package: dw.web
-
-# Class FormElement
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-
-## Description
-
-Represents a form element.
-
-## Properties
-
-### dynamicHtmlName
-
-**Type:** String (Read Only)
-
-A dynamic html name for the field. It can be used to suppress any autocompletion
- support from a browser, e.g. for credit card related fields. It can be also
- used for a unique form name, if one form is used multiple times in a page.
-
-### formId
-
-**Type:** String (Read Only)
-
-The ID of the form element. The is is unique within the parent
- element of the form.
-
-### htmlName
-
-**Type:** String (Read Only)
-
-The global unique name of the field, which can be used as name
- in the html form. For radio buttons this name is not unique.
-
-### parent
-
-**Type:** FormElement (Read Only)
-
-The parent within the form.
-
-### valid
-
-**Type:** boolean (Read Only)
-
-Identifies if this element and all its children elements are
- valid. A form element, which was not submitted in the last
- request is always valid.
-
-### validationResult
-
-**Type:** FormElementValidationResult (Read Only)
-
-Provides a combined view on the validation status as per isValid() and getError(). In
- addition it also provides the data as returned by the validation in case a validation
- script was used.
-
-## Constructor Summary
-
-## Method Summary
-
-### clearFormElement
-
-**Signature:** `clearFormElement() : void`
-
-This method clears the whole form.
-
-### getDynamicHtmlName
-
-**Signature:** `getDynamicHtmlName() : String`
-
-Returns a dynamic html name for the field.
-
-### getFormId
-
-**Signature:** `getFormId() : String`
-
-The ID of the form element.
-
-### getHtmlName
-
-**Signature:** `getHtmlName() : String`
-
-Returns the global unique name of the field, which can be used as name in the html form.
-
-### getParent
-
-**Signature:** `getParent() : FormElement`
-
-The parent within the form.
-
-### getValidationResult
-
-**Signature:** `getValidationResult() : FormElementValidationResult`
-
-Provides a combined view on the validation status as per isValid() and getError().
-
-### invalidateFormElement
-
-**Signature:** `invalidateFormElement() : void`
-
-The method can be called to explicitly invalidate a form element.
-
-### invalidateFormElement
-
-**Signature:** `invalidateFormElement(error : String) : void`
-
-The method can be called to explicitly invalidate a field.
-
-### isValid
-
-**Signature:** `isValid() : boolean`
-
-Identifies if this element and all its children elements are valid.
-
-## Method Detail
-
-## Method Details
-
-### clearFormElement
-
-**Signature:** `clearFormElement() : void`
-
-**Description:** This method clears the whole form. After clearing a form it contains no value or the default value, is not bound to any business object and has the status of being valid.
-
----
-
-### getDynamicHtmlName
-
-**Signature:** `getDynamicHtmlName() : String`
-
-**Description:** Returns a dynamic html name for the field. It can be used to suppress any autocompletion support from a browser, e.g. for credit card related fields. It can be also used for a unique form name, if one form is used multiple times in a page.
-
-**Returns:**
-
-a dynamic html name.
-
----
-
-### getFormId
-
-**Signature:** `getFormId() : String`
-
-**Description:** The ID of the form element. The is is unique within the parent element of the form.
-
-**Returns:**
-
-the ID of the form.
-
----
-
-### getHtmlName
-
-**Signature:** `getHtmlName() : String`
-
-**Description:** Returns the global unique name of the field, which can be used as name in the html form. For radio buttons this name is not unique.
-
-**Returns:**
-
-the global unique name of the field.
-
----
-
-### getParent
-
-**Signature:** `getParent() : FormElement`
-
-**Description:** The parent within the form.
-
-**Returns:**
-
-the parent within the form.
-
----
-
-### getValidationResult
-
-**Signature:** `getValidationResult() : FormElementValidationResult`
-
-**Description:** Provides a combined view on the validation status as per isValid() and getError(). In addition it also provides the data as returned by the validation in case a validation script was used.
-
-**Returns:**
-
-the validation status (valid, error, data)
-
----
-
-### invalidateFormElement
-
-**Signature:** `invalidateFormElement() : void`
-
-**Description:** The method can be called to explicitly invalidate a form element. The error text will be set to the one of two possible preconfigured custom error messages associated with the form definition. The "value-error" message will be used for FormField instances and "form-error" will be used for FormGroup instances.
-
----
-
-### invalidateFormElement
-
-**Signature:** `invalidateFormElement(error : String) : void`
-
-**Description:** The method can be called to explicitly invalidate a field. The error text is set to the given error message.
-
-**Parameters:**
-
-- `error`: the error text to use.
-
----
-
-### isValid
-
-**Signature:** `isValid() : boolean`
-
-**Description:** Identifies if this element and all its children elements are valid. A form element, which was not submitted in the last request is always valid.
-
-**Returns:**
-
-true if this element and all its children elements are valid, false otherwise.
-
----

package/docs/dw_web/FormElementValidationResult.md

@@ -1,157 +0,0 @@
-## Package: dw.web
-
-# Class FormElementValidationResult
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElementValidationResult
-
-## Description
-
-Represents a form element validation result. The validation script specified for form groups and fields can create such FormElementValidationResult with the desired validity, message and data and can then return it. The server side form element validation will evaluate these settings, i.e. calculate the corresponding element validity and message. The optional data provided with this instance will be kept and can be accessed again from the form element after server side validation.
-
-## Properties
-
-### data
-
-**Type:** Map (Read Only)
-
-Provides optional data acquired during validation.
-
-### message
-
-**Type:** String
-
-Provides an optional message in case of validation failure.
-
-### valid
-
-**Type:** boolean
-
-States if the validation succeeded or failed.
-
-## Constructor Summary
-
-FormElementValidationResult(valid : boolean) Creates a FormElementValidationResult with given setting for the validity but without any message.
-
-FormElementValidationResult(valid : boolean, message : String) Creates a FormElementValidationResult with given setting for the validity and corresponding message.
-
-FormElementValidationResult(valid : boolean, message : String, data : Map) Creates a FormElementValidationResult with given setting for the validity and corresponding message.
-
-## Method Summary
-
-### addData
-
-**Signature:** `addData(key : Object, value : Object) : void`
-
-Adds optional data acquired during validation.
-
-### getData
-
-**Signature:** `getData() : Map`
-
-Provides optional data acquired during validation.
-
-### getMessage
-
-**Signature:** `getMessage() : String`
-
-Provides an optional message in case of validation failure.
-
-### isValid
-
-**Signature:** `isValid() : boolean`
-
-States if the validation succeeded or failed.
-
-### setMessage
-
-**Signature:** `setMessage(message : String) : void`
-
-Sets an optional message in case of validation failure.
-
-### setValid
-
-**Signature:** `setValid(valid : boolean) : void`
-
-Sets if the validation succeeded or failed.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### addData
-
-**Signature:** `addData(key : Object, value : Object) : void`
-
-**Description:** Adds optional data acquired during validation.
-
-**Parameters:**
-
-- `key`: the key for which the data value will be stored
-- `value`: the data value that is stored for the given key
-
----
-
-### getData
-
-**Signature:** `getData() : Map`
-
-**Description:** Provides optional data acquired during validation.
-
-**Returns:**
-
-the data acquired during validation
-
----
-
-### getMessage
-
-**Signature:** `getMessage() : String`
-
-**Description:** Provides an optional message in case of validation failure.
-
-**Returns:**
-
-the message for validation failure
-
----
-
-### isValid
-
-**Signature:** `isValid() : boolean`
-
-**Description:** States if the validation succeeded or failed.
-
-**Returns:**
-
-true if the validation succeeded
-
----
-
-### setMessage
-
-**Signature:** `setMessage(message : String) : void`
-
-**Description:** Sets an optional message in case of validation failure.
-
-**Parameters:**
-
-- `message`: the message for validation failure
-
----
-
-### setValid
-
-**Signature:** `setValid(valid : boolean) : void`
-
-**Description:** Sets if the validation succeeded or failed.
-
-**Parameters:**
-
-- `valid`: if the validation succeeded
-
----