@salesforce/b2c-cli 0.0.5 → 0.0.8

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.web.Form.md

@@ -1,84 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Form
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.FormElement](dw.web.FormElement.md)
-    - [dw.web.FormGroup](dw.web.FormGroup.md)
-      - [dw.web.Form](dw.web.Form.md)
-
-The class is the top level element in the form instance hierachy.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [secureKeyHtmlName](#securekeyhtmlname): [String](TopLevel.String.md) `(read-only)` | Returns the secure key html name to be used for the hidden input field  that will contain the secure key value. |
-| [secureKeyValue](#securekeyvalue): [String](TopLevel.String.md) `(read-only)` | Returns the secure key value that is generated for the form to use  in a hidden input field for authentication. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getSecureKeyHtmlName](dw.web.Form.md#getsecurekeyhtmlname)() | Returns the secure key html name to be used for the hidden input field  that will contain the secure key value. |
-| [getSecureKeyValue](dw.web.Form.md#getsecurekeyvalue)() | Returns the secure key value that is generated for the form to use  in a hidden input field for authentication. |
-
-### Methods inherited from class FormGroup
-
-[accept](dw.web.FormGroup.md#accept), [copyFrom](dw.web.FormGroup.md#copyfromobject), [copyTo](dw.web.FormGroup.md#copytoobject), [getChildCount](dw.web.FormGroup.md#getchildcount), [getError](dw.web.FormGroup.md#geterror), [getObject](dw.web.FormGroup.md#getobject), [getSubmittedAction](dw.web.FormGroup.md#getsubmittedaction), [getTriggeredAction](dw.web.FormGroup.md#gettriggeredaction)
-### Methods inherited from class FormElement
-
-[clearFormElement](dw.web.FormElement.md#clearformelement), [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname), [getFormId](dw.web.FormElement.md#getformid), [getHtmlName](dw.web.FormElement.md#gethtmlname), [getParent](dw.web.FormElement.md#getparent), [getValidationResult](dw.web.FormElement.md#getvalidationresult), [invalidateFormElement](dw.web.FormElement.md#invalidateformelement), [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring), [isValid](dw.web.FormElement.md#isvalid)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### secureKeyHtmlName
-- secureKeyHtmlName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the secure key html name to be used for the hidden input field
-      that will contain the secure key value.
-
-
-
----
-
-### secureKeyValue
-- secureKeyValue: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the secure key value that is generated for the form to use
-      in a hidden input field for authentication.
-
-
-
----
-
-## Method Details
-
-### getSecureKeyHtmlName()
-- getSecureKeyHtmlName(): [String](TopLevel.String.md)
-  - : 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()
-- getSecureKeyValue(): [String](TopLevel.String.md)
-  - : 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
-
-
----
-
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.web.FormAction.md

@@ -1,195 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FormAction
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.FormElement](dw.web.FormElement.md)
-    - [dw.web.FormAction](dw.web.FormAction.md)
-
-The FormAction class represents the action in form instance hierarchy.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the optional description for the action. |
-| [label](#label): [String](TopLevel.String.md) `(read-only)` | Returns the optional label for the action. |
-| [object](#object): [Object](TopLevel.Object.md) `(read-only)` | Returns the object that was bound to the form in which the action  is contained. |
-| [submitted](#submitted): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the form action was submitted from  the client to the server. |
-| [triggered](#triggered): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies that this action is triggerd. |
-| [x](#x): [Number](TopLevel.Number.md) `(read-only)` | In case of an image button, returns the x coordinate of the last click. |
-| [y](#y): [Number](TopLevel.Number.md) `(read-only)` | In case of an image button, returns the y coordinate of the last click. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getDescription](dw.web.FormAction.md#getdescription)() | Returns the optional description for the action. |
-| [getLabel](dw.web.FormAction.md#getlabel)() | Returns the optional label for the action. |
-| [getObject](dw.web.FormAction.md#getobject)() | Returns the object that was bound to the form in which the action  is contained. |
-| [getX](dw.web.FormAction.md#getx)() | In case of an image button, returns the x coordinate of the last click. |
-| [getY](dw.web.FormAction.md#gety)() | In case of an image button, returns the y coordinate of the last click. |
-| [isSubmitted](dw.web.FormAction.md#issubmitted)() | Identifies if the form action was submitted from  the client to the server. |
-| [isTriggered](dw.web.FormAction.md#istriggered)() | Identifies that this action is triggerd. |
-
-### Methods inherited from class FormElement
-
-[clearFormElement](dw.web.FormElement.md#clearformelement), [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname), [getFormId](dw.web.FormElement.md#getformid), [getHtmlName](dw.web.FormElement.md#gethtmlname), [getParent](dw.web.FormElement.md#getparent), [getValidationResult](dw.web.FormElement.md#getvalidationresult), [invalidateFormElement](dw.web.FormElement.md#invalidateformelement), [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring), [isValid](dw.web.FormElement.md#isvalid)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### description
-- description: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the optional description for the action. The description could be used
-      as tooltip for the action.
-
-
-
----
-
-### label
-- label: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the optional label for the action. The label would be typically used
-      as button text.
-
-
-
----
-
-### object
-- object: [Object](TopLevel.Object.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### submitted
-- submitted: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the form action was submitted from
-      the client to the server.
-
-
-
----
-
-### triggered
-- triggered: [Boolean](TopLevel.Boolean.md) `(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
-- x: [Number](TopLevel.Number.md) `(read-only)`
-  - : In case of an image button, returns the x coordinate of the last click.
-
-
----
-
-### y
-- y: [Number](TopLevel.Number.md) `(read-only)`
-  - : In case of an image button, returns the y coordinate of the last click.
-
-
----
-
-## Method Details
-
-### getDescription()
-- getDescription(): [String](TopLevel.String.md)
-  - : 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()
-- getLabel(): [String](TopLevel.String.md)
-  - : Returns the optional label for the action. The label would be typically used
-      as button text.
-
-
-    **Returns:**
-    - the optional label for the action.
-
-
----
-
-### getObject()
-- getObject(): [Object](TopLevel.Object.md)
-  - : 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()
-- getX(): [Number](TopLevel.Number.md)
-  - : In case of an image button, returns the x coordinate of the last click.
-
-    **Returns:**
-    - the x coordinate of the last click.
-
-
----
-
-### getY()
-- getY(): [Number](TopLevel.Number.md)
-  - : In case of an image button, returns the y coordinate of the last click.
-
-    **Returns:**
-    - the y coordinate of the last click.
-
-
----
-
-### isSubmitted()
-- isSubmitted(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the form action was submitted from
-      the client to the server.
-
-
-    **Returns:**
-    - true if the form action was submitted, false otherwise.
-
-
----
-
-### isTriggered()
-- isTriggered(): [Boolean](TopLevel.Boolean.md)
-  - : 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.
-
-
----
-
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.web.FormElement.md

@@ -1,211 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FormElement
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.FormElement](dw.web.FormElement.md)
-
-Represents a form element.
-
-
-## All Known Subclasses
-[Form](dw.web.Form.md), [FormAction](dw.web.FormAction.md), [FormField](dw.web.FormField.md), [FormGroup](dw.web.FormGroup.md), [FormList](dw.web.FormList.md), [FormListItem](dw.web.FormListItem.md)
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [dynamicHtmlName](#dynamichtmlname): [String](TopLevel.String.md) `(read-only)` | Returns a dynamic html name for the field. |
-| [formId](#formid): [String](TopLevel.String.md) `(read-only)` | The ID of the form element. |
-| [htmlName](#htmlname): [String](TopLevel.String.md) `(read-only)` | Returns the global unique name of the field, which can be used as name  in the html form. |
-| [parent](#parent): [FormElement](dw.web.FormElement.md) `(read-only)` | The parent within the form. |
-| [valid](#valid): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this element and all its children elements are  valid. |
-| [validationResult](#validationresult): [FormElementValidationResult](dw.web.FormElementValidationResult.md) `(read-only)` | Provides a combined view on the validation status as per isValid() and getError(). |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [clearFormElement](dw.web.FormElement.md#clearformelement)() | This method clears the whole form. |
-| [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname)() | Returns a dynamic html name for the field. |
-| [getFormId](dw.web.FormElement.md#getformid)() | The ID of the form element. |
-| [getHtmlName](dw.web.FormElement.md#gethtmlname)() | Returns the global unique name of the field, which can be used as name  in the html form. |
-| [getParent](dw.web.FormElement.md#getparent)() | The parent within the form. |
-| [getValidationResult](dw.web.FormElement.md#getvalidationresult)() | Provides a combined view on the validation status as per isValid() and getError(). |
-| [invalidateFormElement](dw.web.FormElement.md#invalidateformelement)() | The method can be called to explicitly invalidate a form element. |
-| [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring)([String](TopLevel.String.md)) | The method can be called to explicitly invalidate a field. |
-| [isValid](dw.web.FormElement.md#isvalid)() | Identifies if this element and all its children elements are  valid. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### dynamicHtmlName
-- dynamicHtmlName: [String](TopLevel.String.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### formId
-- formId: [String](TopLevel.String.md) `(read-only)`
-  - : The ID of the form element. The is is unique within the parent
-      element of the form.
-
-
-
----
-
-### htmlName
-- htmlName: [String](TopLevel.String.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### parent
-- parent: [FormElement](dw.web.FormElement.md) `(read-only)`
-  - : The parent within the form.
-
-
----
-
-### valid
-- valid: [Boolean](TopLevel.Boolean.md) `(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
-- validationResult: [FormElementValidationResult](dw.web.FormElementValidationResult.md) `(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.
-
-
-
----
-
-## Method Details
-
-### clearFormElement()
-- clearFormElement(): void
-  - : 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()
-- getDynamicHtmlName(): [String](TopLevel.String.md)
-  - : 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()
-- getFormId(): [String](TopLevel.String.md)
-  - : The ID of the form element. The is is unique within the parent
-      element of the form.
-
-
-    **Returns:**
-    - the ID of the form.
-
-
----
-
-### getHtmlName()
-- getHtmlName(): [String](TopLevel.String.md)
-  - : 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()
-- getParent(): [FormElement](dw.web.FormElement.md)
-  - : The parent within the form.
-
-    **Returns:**
-    - the parent within the form.
-
-
----
-
-### getValidationResult()
-- getValidationResult(): [FormElementValidationResult](dw.web.FormElementValidationResult.md)
-  - : 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()
-- invalidateFormElement(): void
-  - : 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(String)
-- invalidateFormElement(error: [String](TopLevel.String.md)): void
-  - : 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()
-- isValid(): [Boolean](TopLevel.Boolean.md)
-  - : 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.
-
-
-
----
-
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.web.FormElementValidationResult.md

@@ -1,170 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FormElementValidationResult
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.FormElementValidationResult](dw.web.FormElementValidationResult.md)
-
-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.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [data](#data): [Map](dw.util.Map.md) `(read-only)` | Provides optional data acquired during validation. |
-| [message](#message): [String](TopLevel.String.md) | Provides an optional message in case of validation failure. |
-| [valid](#valid): [Boolean](TopLevel.Boolean.md) | States if the validation succeeded or failed. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [FormElementValidationResult](#formelementvalidationresultboolean)([Boolean](TopLevel.Boolean.md)) | Creates a FormElementValidationResult with given setting for the validity but without any message. |
-| [FormElementValidationResult](#formelementvalidationresultboolean-string)([Boolean](TopLevel.Boolean.md), [String](TopLevel.String.md)) | Creates a FormElementValidationResult with given setting for the validity and corresponding message. |
-| [FormElementValidationResult](#formelementvalidationresultboolean-string-map)([Boolean](TopLevel.Boolean.md), [String](TopLevel.String.md), [Map](dw.util.Map.md)) | Creates a FormElementValidationResult with given setting for the validity and corresponding message. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [addData](dw.web.FormElementValidationResult.md#adddataobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Adds optional data acquired during validation. |
-| [getData](dw.web.FormElementValidationResult.md#getdata)() | Provides optional data acquired during validation. |
-| [getMessage](dw.web.FormElementValidationResult.md#getmessage)() | Provides an optional message in case of validation failure. |
-| [isValid](dw.web.FormElementValidationResult.md#isvalid)() | States if the validation succeeded or failed. |
-| [setMessage](dw.web.FormElementValidationResult.md#setmessagestring)([String](TopLevel.String.md)) | Sets an optional message in case of validation failure. |
-| [setValid](dw.web.FormElementValidationResult.md#setvalidboolean)([Boolean](TopLevel.Boolean.md)) | Sets if the validation succeeded or failed. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### data
-- data: [Map](dw.util.Map.md) `(read-only)`
-  - : Provides optional data acquired during validation.
-
-
----
-
-### message
-- message: [String](TopLevel.String.md)
-  - : Provides an optional message in case of validation failure.
-
-
----
-
-### valid
-- valid: [Boolean](TopLevel.Boolean.md)
-  - : States if the validation succeeded or failed.
-
-
----
-
-## Constructor Details
-
-### FormElementValidationResult(Boolean)
-- FormElementValidationResult(valid: [Boolean](TopLevel.Boolean.md))
-  - : Creates a FormElementValidationResult with given setting for the validity but without any message.
-
-    **Parameters:**
-    - valid - the desired validity
-
-
----
-
-### FormElementValidationResult(Boolean, String)
-- FormElementValidationResult(valid: [Boolean](TopLevel.Boolean.md), message: [String](TopLevel.String.md))
-  - : Creates a FormElementValidationResult with given setting for the validity and corresponding message.
-      This is especially useful to represent a failed validation including some error message.
-
-
-    **Parameters:**
-    - valid - the desired validity
-    - message - the desired message
-
-
----
-
-### FormElementValidationResult(Boolean, String, Map)
-- FormElementValidationResult(valid: [Boolean](TopLevel.Boolean.md), message: [String](TopLevel.String.md), data: [Map](dw.util.Map.md))
-  - : Creates a FormElementValidationResult with given setting for the validity and corresponding message.
-      This is especially useful to represent a failed validation including some error message. Additional
-      data can be stored, too.
-
-
-    **Parameters:**
-    - valid - the desired validity
-    - message - the desired message
-    - data - the desired data
-
-
----
-
-## Method Details
-
-### addData(Object, Object)
-- addData(key: [Object](TopLevel.Object.md), value: [Object](TopLevel.Object.md)): void
-  - : 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()
-- getData(): [Map](dw.util.Map.md)
-  - : Provides optional data acquired during validation.
-
-    **Returns:**
-    - the data acquired during validation
-
-
----
-
-### getMessage()
-- getMessage(): [String](TopLevel.String.md)
-  - : Provides an optional message in case of validation failure.
-
-    **Returns:**
-    - the message for validation failure
-
-
----
-
-### isValid()
-- isValid(): [Boolean](TopLevel.Boolean.md)
-  - : States if the validation succeeded or failed.
-
-    **Returns:**
-    - true if the validation succeeded
-
-
----
-
-### setMessage(String)
-- setMessage(message: [String](TopLevel.String.md)): void
-  - : Sets an optional message in case of validation failure.
-
-    **Parameters:**
-    - message - the message for validation failure
-
-
----
-
-### setValid(Boolean)
-- setValid(valid: [Boolean](TopLevel.Boolean.md)): void
-  - : Sets if the validation succeeded or failed.
-
-    **Parameters:**
-    - valid - if the validation succeeded
-
-
----
-
-<!-- prettier-ignore-end -->