@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.web.FormFieldOption.md

@@ -0,0 +1,211 @@
+<!-- prettier-ignore-start -->
+# Class FormFieldOption
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.FormFieldOption](dw.web.FormFieldOption.md)
+
+Represents an option for a form field.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [checked](#checked): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this option is checked. |
+| [htmlValue](#htmlvalue): [String](TopLevel.String.md) `(read-only)` | Returns the value for the HTML value attribute of a HTML option element. |
+| [label](#label): [String](TopLevel.String.md) | Returns the value for the HTML label attribute of the HTML option element. |
+| [object](#object): [Object](TopLevel.Object.md) `(read-only)` | Returns the object that was bound to this option value. |
+| [optionId](#optionid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the option. |
+| [parent](#parent): [FormField](dw.web.FormField.md) `(read-only)` | The parent, which is a field element. |
+| [selected](#selected): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this option is selected. |
+| [value](#value): [Object](TopLevel.Object.md) `(read-only)` | The actual value associated with this option. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getHtmlValue](dw.web.FormFieldOption.md#gethtmlvalue)() | Returns the value for the HTML value attribute of a HTML option element. |
+| [getLabel](dw.web.FormFieldOption.md#getlabel)() | Returns the value for the HTML label attribute of the HTML option element. |
+| [getObject](dw.web.FormFieldOption.md#getobject)() | Returns the object that was bound to this option value. |
+| [getOptionId](dw.web.FormFieldOption.md#getoptionid)() | Returns the ID of the option. |
+| [getParent](dw.web.FormFieldOption.md#getparent)() | The parent, which is a field element. |
+| [getValue](dw.web.FormFieldOption.md#getvalue)() | The actual value associated with this option. |
+| [isChecked](dw.web.FormFieldOption.md#ischecked)() | Identifies if this option is checked. |
+| [isSelected](dw.web.FormFieldOption.md#isselected)() | Identifies if this option is selected. |
+| [setLabel](dw.web.FormFieldOption.md#setlabelstring)([String](TopLevel.String.md)) | Sets the label attribute for this option. |
+
+### 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
+
+### checked
+- checked: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this option is checked.
+
+
+---
+
+### htmlValue
+- htmlValue: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value for the HTML value attribute of a HTML option element.
+
+
+---
+
+### label
+- label: [String](TopLevel.String.md)
+  - : Returns the value for the HTML label attribute of the HTML option element.
+      If not specified in the form option definition the label is identical with
+      the string representation of option value (see getValue()).
+
+
+
+---
+
+### object
+- object: [Object](TopLevel.Object.md) `(read-only)`
+  - : Returns the object that was bound to this option value.
+
+
+---
+
+### optionId
+- optionId: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the ID of the option. This is an internal ID used to uniquely
+      reference this option. If not specified in the form option definition
+      the ID is identical with the string representation of the option value
+      (see getValue()).
+
+
+
+---
+
+### parent
+- parent: [FormField](dw.web.FormField.md) `(read-only)`
+  - : The parent, which is a field element.
+
+
+---
+
+### selected
+- selected: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this option is selected.
+
+
+---
+
+### value
+- value: [Object](TopLevel.Object.md) `(read-only)`
+  - : The actual value associated with this option. This value is formatted
+      and than returned as HTML value with the method getHtmlValue().
+
+
+
+---
+
+## Method Details
+
+### getHtmlValue()
+- getHtmlValue(): [String](TopLevel.String.md)
+  - : Returns the value for the HTML value attribute of a HTML option element.
+
+    **Returns:**
+    - the value for the HTML value attribute of a HTML option element.
+
+
+---
+
+### getLabel()
+- getLabel(): [String](TopLevel.String.md)
+  - : Returns the value for the HTML label attribute of the HTML option element.
+      If not specified in the form option definition the label is identical with
+      the string representation of option value (see getValue()).
+
+
+    **Returns:**
+    - the value for the HTML label attribute of the HTML option element.
+
+
+---
+
+### getObject()
+- getObject(): [Object](TopLevel.Object.md)
+  - : Returns the object that was bound to this option value.
+
+    **Returns:**
+    - the object that was bound to this option value.
+
+
+---
+
+### getOptionId()
+- getOptionId(): [String](TopLevel.String.md)
+  - : Returns the ID of the option. This is an internal ID used to uniquely
+      reference this option. If not specified in the form option definition
+      the ID is identical with the string representation of the option value
+      (see getValue()).
+
+
+    **Returns:**
+    - the ID of the option.
+
+
+---
+
+### getParent()
+- getParent(): [FormField](dw.web.FormField.md)
+  - : The parent, which is a field element.
+
+    **Returns:**
+    - the parent form field.
+
+
+---
+
+### getValue()
+- getValue(): [Object](TopLevel.Object.md)
+  - : The actual value associated with this option. This value is formatted
+      and than returned as HTML value with the method getHtmlValue().
+
+
+    **Returns:**
+    - the value associated with this option
+
+
+---
+
+### isChecked()
+- isChecked(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this option is checked.
+
+    **Returns:**
+    - true if this option is checked, false otherwise.
+
+
+---
+
+### isSelected()
+- isSelected(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this option is selected.
+
+    **Returns:**
+    - true if this option is selected, false otherwise.
+
+
+---
+
+### setLabel(String)
+- setLabel(label: [String](TopLevel.String.md)): void
+  - : Sets the label attribute for this option.
+
+    **Parameters:**
+    - label - the label value.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.web.FormFieldOptions.md

@@ -0,0 +1,49 @@
+<!-- prettier-ignore-start -->
+# Class FormFieldOptions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.FormFieldOptions](dw.web.FormFieldOptions.md)
+
+The class represents the list of options for a field. The class supports
+an index style access to the options, e.g. myfield.options\[2\] or
+myfield.options.red.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [optionsCount](#optionscount): [Number](TopLevel.Number.md) `(read-only)` | Returns the number of option values. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getOptionsCount](dw.web.FormFieldOptions.md#getoptionscount)() | Returns the number of option values. |
+
+### 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
+
+### optionsCount
+- optionsCount: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the number of option values.
+
+
+---
+
+## Method Details
+
+### getOptionsCount()
+- getOptionsCount(): [Number](TopLevel.Number.md)
+  - : Returns the number of option values.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.web.FormGroup.md

@@ -0,0 +1,222 @@
+<!-- prettier-ignore-start -->
+# Class FormGroup
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.FormElement](dw.web.FormElement.md)
+    - [dw.web.FormGroup](dw.web.FormGroup.md)
+
+The class is the central class within the whole form handling. It is
+the container element for fields and other form elements. A form group
+can contain other forms, also called sub-forms.
+
+Access to the elements of a form is provided via an index based access or
+via an associative array access. For example, the field "firstname" can be accessed
+with the expression "myform.firstname".
+
+
+
+## All Known Subclasses
+[Form](dw.web.Form.md), [FormList](dw.web.FormList.md), [FormListItem](dw.web.FormListItem.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [childCount](#childcount): [Number](TopLevel.Number.md) `(read-only)` | Returns the number of elements in the form. |
+| [error](#error): [String](TopLevel.String.md) `(read-only)` | Returns a form-wide error message. |
+| [object](#object): [Object](TopLevel.Object.md) `(read-only)` | The object that was bound to this form group. |
+| [submittedAction](#submittedaction): [FormAction](dw.web.FormAction.md) `(read-only)` | Returns the action that was submitted with the last request. |
+| [triggeredAction](#triggeredaction): [FormAction](dw.web.FormAction.md) `(read-only)` | Returns the action that was triggered with the last request. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [accept](dw.web.FormGroup.md#accept)() | The method copies the value from a form into the object, which was previously  bound to the form. |
+| [copyFrom](dw.web.FormGroup.md#copyfromobject)([Object](TopLevel.Object.md)) | The method updates the form with the values from the given object.    The method call is basically equivalent to the pipelet UpdateFormWithObject.    The method not only copies the value, it also binds the object to the form. |
+| [copyTo](dw.web.FormGroup.md#copytoobject)([Object](TopLevel.Object.md)) | The method updates the object with the values from the form.    The method call is basically equivalent to the pipelet UpdateObjectWithForm.    The method needs a submitted form. |
+| [getChildCount](dw.web.FormGroup.md#getchildcount)() | Returns the number of elements in the form. |
+| [getError](dw.web.FormGroup.md#geterror)() | Returns a form-wide error message. |
+| [getObject](dw.web.FormGroup.md#getobject)() | The object that was bound to this form group. |
+| [getSubmittedAction](dw.web.FormGroup.md#getsubmittedaction)() | Returns the action that was submitted with the last request. |
+| [getTriggeredAction](dw.web.FormGroup.md#gettriggeredaction)() | Returns the action that was triggered with the last request. |
+
+### 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
+
+### childCount
+- childCount: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the number of elements in the form.
+
+
+---
+
+### error
+- error: [String](TopLevel.String.md) `(read-only)`
+  - : Returns a form-wide error message. If no error message
+      is present the method returns null.
+
+
+
+---
+
+### object
+- object: [Object](TopLevel.Object.md) `(read-only)`
+  - : The object that was bound to this form group.
+
+
+---
+
+### submittedAction
+- submittedAction: [FormAction](dw.web.FormAction.md) `(read-only)`
+  - : Returns the action that was submitted with the last request. The action is
+      set independent whether the form must be valid for this action. The method
+      returns null if no action at all was submitted with the last request for this
+      form group.
+
+
+
+---
+
+### triggeredAction
+- triggeredAction: [FormAction](dw.web.FormAction.md) `(read-only)`
+  - : Returns the action that was triggered with the last request. An action is
+      only marked as triggered if the constraints regarding form validation are
+      meet. The method returns null if no action was marked as triggered.
+
+
+
+---
+
+## Method Details
+
+### accept()
+- accept(): void
+  - : The method copies the value from a form into the object, which was previously
+      bound to the form. The method is equivalent to the pipelet AcceptForm.
+      
+      This method is equivalent to the call formgroup.copyFrom( formgroup.object ).
+
+
+
+---
+
+### copyFrom(Object)
+- copyFrom(obj: [Object](TopLevel.Object.md)): void
+  - : The method updates the form with the values from the given object.
+      
+      
+      
+      The method call is basically equivalent to the pipelet UpdateFormWithObject.
+      
+      
+      
+      The method not only copies the value, it also binds the object to the form. Binding means that the form keeps the
+      information from which objects the values were taken. This can be used for two purposes:
+      
+      1. for lists it makes it easier in the code to find the associated object, for example in case of a related   action, and
+      2. it allows to copy back the values from the form into the object (see [accept()](dw.web.FormGroup.md#accept)).
+      
+      Because of this bind behavior, the operation is also sometimes called a bind-operation.
+
+
+    **Parameters:**
+    - obj - the object from, which the values are read
+
+
+---
+
+### copyTo(Object)
+- copyTo(obj: [Object](TopLevel.Object.md)): void
+  - : The method updates the object with the values from the form.
+      
+      
+      
+      The method call is basically equivalent to the pipelet UpdateObjectWithForm.
+      
+      
+      
+      The method needs a submitted form. The copyTo call is delegated to the form fields. Each form field than checks
+      if its value was submitted as part of the form:
+      
+      - If this is _true_, the object gets updated with the form field value.
+      - If this is _false_, the object will not be updated.
+      
+      This is the reason why you cannot copy values from one object into another object by using
+      [copyFrom(Object)](dw.web.FormGroup.md#copyfromobject) and [copyTo(Object)](dw.web.FormGroup.md#copytoobject) within the same request (e.g. by one call to a script or
+      controller).
+
+
+    **Parameters:**
+    - obj - the object, which is updated from the form
+
+
+---
+
+### getChildCount()
+- getChildCount(): [Number](TopLevel.Number.md)
+  - : Returns the number of elements in the form.
+
+    **Returns:**
+    - the number of elements in the form.
+
+
+---
+
+### getError()
+- getError(): [String](TopLevel.String.md)
+  - : Returns a form-wide error message. If no error message
+      is present the method returns null.
+
+
+    **Returns:**
+    - a form-wide error message or null.
+
+
+---
+
+### getObject()
+- getObject(): [Object](TopLevel.Object.md)
+  - : The object that was bound to this form group.
+
+    **Returns:**
+    - the bound object.
+
+
+---
+
+### getSubmittedAction()
+- getSubmittedAction(): [FormAction](dw.web.FormAction.md)
+  - : Returns the action that was submitted with the last request. The action is
+      set independent whether the form must be valid for this action. The method
+      returns null if no action at all was submitted with the last request for this
+      form group.
+
+
+    **Returns:**
+    - the action that was submitted with the last request or null.
+
+
+---
+
+### getTriggeredAction()
+- getTriggeredAction(): [FormAction](dw.web.FormAction.md)
+  - : Returns the action that was triggered with the last request. An action is
+      only marked as triggered if the constraints regarding form validation are
+      meet. The method returns null if no action was marked as triggered.
+
+
+    **Returns:**
+    - the action that was triggered with the last request.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.web.FormList.md

@@ -0,0 +1,134 @@
+<!-- prettier-ignore-start -->
+# Class FormList
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.FormElement](dw.web.FormElement.md)
+    - [dw.web.FormGroup](dw.web.FormGroup.md)
+      - [dw.web.FormList](dw.web.FormList.md)
+
+Represents a list of forms.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [selectManyItems](#selectmanyitems): [List](dw.util.List.md) `(read-only)` | returns the selected list items if the list is  configured to support selection of items. |
+| [selectManyObjects](#selectmanyobjects): [List](dw.util.List.md) `(read-only)` | Returns a list of all selected objects if the list is configured  to support the selection of items. |
+| [selectOneItem](#selectoneitem): [FormListItem](dw.web.FormListItem.md) `(read-only)` | Returns the default list item if the list is configured to  support the selection of a default item. |
+| [selectOneObject](#selectoneobject): [Object](TopLevel.Object.md) `(read-only)` | Returns the selected object if the list is configured to  support the selection of a default item. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getSelectManyItems](dw.web.FormList.md#getselectmanyitems)() | returns the selected list items if the list is  configured to support selection of items. |
+| [getSelectManyObjects](dw.web.FormList.md#getselectmanyobjects)() | Returns a list of all selected objects if the list is configured  to support the selection of items. |
+| [getSelectOneItem](dw.web.FormList.md#getselectoneitem)() | Returns the default list item if the list is configured to  support the selection of a default item. |
+| [getSelectOneObject](dw.web.FormList.md#getselectoneobject)() | Returns the selected object if the list is configured to  support the selection of a default item. |
+
+### 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
+
+### selectManyItems
+- selectManyItems: [List](dw.util.List.md) `(read-only)`
+  - : returns the selected list items if the list is
+      configured to support selection of items.
+
+
+
+---
+
+### selectManyObjects
+- selectManyObjects: [List](dw.util.List.md) `(read-only)`
+  - : Returns a list of all selected objects if the list is configured
+      to support the selection of items. The objects are the objects that were
+      bound to each row.
+
+
+
+---
+
+### selectOneItem
+- selectOneItem: [FormListItem](dw.web.FormListItem.md) `(read-only)`
+  - : Returns the default list item if the list is configured to
+      support the selection of a default item.
+
+
+
+---
+
+### selectOneObject
+- selectOneObject: [Object](TopLevel.Object.md) `(read-only)`
+  - : Returns the selected object if the list is configured to
+      support the selection of a default item. The object is the object
+      bound to the item.
+
+
+
+---
+
+## Method Details
+
+### getSelectManyItems()
+- getSelectManyItems(): [List](dw.util.List.md)
+  - : returns the selected list items if the list is
+      configured to support selection of items.
+
+
+    **Returns:**
+    - a List of FormListItem elements or null if no selection was configured for the form.
+
+
+---
+
+### getSelectManyObjects()
+- getSelectManyObjects(): [List](dw.util.List.md)
+  - : Returns a list of all selected objects if the list is configured
+      to support the selection of items. The objects are the objects that were
+      bound to each row.
+
+
+    **Returns:**
+    - a List of objects or null if no selection was configured for the form.
+
+
+---
+
+### getSelectOneItem()
+- getSelectOneItem(): [FormListItem](dw.web.FormListItem.md)
+  - : Returns the default list item if the list is configured to
+      support the selection of a default item.
+
+
+    **Returns:**
+    - the default FormListItem elements or null if no selection was configured
+
+
+---
+
+### getSelectOneObject()
+- getSelectOneObject(): [Object](TopLevel.Object.md)
+  - : Returns the selected object if the list is configured to
+      support the selection of a default item. The object is the object
+      bound to the item.
+
+
+    **Returns:**
+    - the selected object.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.web.FormListItem.md

@@ -0,0 +1,57 @@
+<!-- prettier-ignore-start -->
+# Class FormListItem
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.web.FormElement](dw.web.FormElement.md)
+    - [dw.web.FormGroup](dw.web.FormGroup.md)
+      - [dw.web.FormListItem](dw.web.FormListItem.md)
+
+Represents an item in a form list.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [itemIndex](#itemindex): [Number](TopLevel.Number.md) `(read-only)` | Returns the index of this item with the list. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getItemIndex](dw.web.FormListItem.md#getitemindex)() | Returns the index of this item with the list. |
+
+### 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
+
+### itemIndex
+- itemIndex: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the index of this item with the list.
+
+
+---
+
+## Method Details
+
+### getItemIndex()
+- getItemIndex(): [Number](TopLevel.Number.md)
+  - : Returns the index of this item with the list.
+
+    **Returns:**
+    - the index of this item with the list.
+
+
+---
+
+<!-- prettier-ignore-end -->