sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/dw_web/FormFieldOption.md

@@ -1,238 +0,0 @@
-## Package: dw.web
-
-# Class FormFieldOption
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormFieldOption
-
-## Description
-
-Represents an option for a form field.
-
-## Properties
-
-### checked
-
-**Type:** boolean (Read Only)
-
-Identifies if this option is checked.
-
-### htmlValue
-
-**Type:** String (Read Only)
-
-The value for the HTML value attribute of a HTML option element.
-
-### label
-
-**Type:** String
-
-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
-
-**Type:** Object (Read Only)
-
-The object that was bound to this option value.
-
-### optionId
-
-**Type:** String (Read Only)
-
-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
-
-**Type:** FormField (Read Only)
-
-The parent, which is a field element.
-
-### selected
-
-**Type:** boolean (Read Only)
-
-Identifies if this option is selected.
-
-### value
-
-**Type:** Object (Read Only)
-
-The actual value associated with this option. This value is formatted
- and than returned as HTML value with the method getHtmlValue().
-
-## Constructor Summary
-
-## Method Summary
-
-### getHtmlValue
-
-**Signature:** `getHtmlValue() : String`
-
-Returns the value for the HTML value attribute of a HTML option element.
-
-### getLabel
-
-**Signature:** `getLabel() : String`
-
-Returns the value for the HTML label attribute of the HTML option element.
-
-### getObject
-
-**Signature:** `getObject() : Object`
-
-Returns the object that was bound to this option value.
-
-### getOptionId
-
-**Signature:** `getOptionId() : String`
-
-Returns the ID of the option.
-
-### getParent
-
-**Signature:** `getParent() : FormField`
-
-The parent, which is a field element.
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-The actual value associated with this option.
-
-### isChecked
-
-**Signature:** `isChecked() : boolean`
-
-Identifies if this option is checked.
-
-### isSelected
-
-**Signature:** `isSelected() : boolean`
-
-Identifies if this option is selected.
-
-### setLabel
-
-**Signature:** `setLabel(label : String) : void`
-
-Sets the label attribute for this option.
-
-## Method Detail
-
-## Method Details
-
-### getHtmlValue
-
-**Signature:** `getHtmlValue() : String`
-
-**Description:** 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
-
-**Signature:** `getLabel() : String`
-
-**Description:** 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
-
-**Signature:** `getObject() : Object`
-
-**Description:** Returns the object that was bound to this option value.
-
-**Returns:**
-
-the object that was bound to this option value.
-
----
-
-### getOptionId
-
-**Signature:** `getOptionId() : String`
-
-**Description:** 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
-
-**Signature:** `getParent() : FormField`
-
-**Description:** The parent, which is a field element.
-
-**Returns:**
-
-the parent form field.
-
----
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-**Description:** 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
-
-**Signature:** `isChecked() : boolean`
-
-**Description:** Identifies if this option is checked.
-
-**Returns:**
-
-true if this option is checked, false otherwise.
-
----
-
-### isSelected
-
-**Signature:** `isSelected() : boolean`
-
-**Description:** Identifies if this option is selected.
-
-**Returns:**
-
-true if this option is selected, false otherwise.
-
----
-
-### setLabel
-
-**Signature:** `setLabel(label : String) : void`
-
-**Description:** Sets the label attribute for this option.
-
-**Parameters:**
-
-- `label`: the label value.
-
----

package/docs/dw_web/FormFieldOptions.md

@@ -1,42 +0,0 @@
-## Package: dw.web
-
-# Class FormFieldOptions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormFieldOptions
-
-## Description
-
-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.
-
-## Properties
-
-### optionsCount
-
-**Type:** Number (Read Only)
-
-The number of option values.
-
-## Constructor Summary
-
-## Method Summary
-
-### getOptionsCount
-
-**Signature:** `getOptionsCount() : Number`
-
-Returns the number of option values.
-
-## Method Detail
-
-## Method Details
-
-### getOptionsCount
-
-**Signature:** `getOptionsCount() : Number`
-
-**Description:** Returns the number of option values.
-
----

package/docs/dw_web/FormGroup.md

@@ -1,199 +0,0 @@
-## Package: dw.web
-
-# Class FormGroup
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-  - dw.web.FormGroup
-
-## Description
-
-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".
-
-## Properties
-
-### childCount
-
-**Type:** Number (Read Only)
-
-The number of elements in the form.
-
-### error
-
-**Type:** String (Read Only)
-
-A form-wide error message. If no error message
- is present the method returns null.
-
-### object
-
-**Type:** Object (Read Only)
-
-The object that was bound to this form group.
-
-### submittedAction
-
-**Type:** FormAction (Read Only)
-
-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
-
-**Type:** FormAction (Read Only)
-
-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.
-
-## Constructor Summary
-
-## Method Summary
-
-### accept
-
-**Signature:** `accept() : void`
-
-The method copies the value from a form into the object, which was previously bound to the form.
-
-### copyFrom
-
-**Signature:** `copyFrom(obj : Object) : 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.
-
-### copyTo
-
-**Signature:** `copyTo(obj : Object) : 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.
-
-### getChildCount
-
-**Signature:** `getChildCount() : Number`
-
-Returns the number of elements in the form.
-
-### getError
-
-**Signature:** `getError() : String`
-
-Returns a form-wide error message.
-
-### getObject
-
-**Signature:** `getObject() : Object`
-
-The object that was bound to this form group.
-
-### getSubmittedAction
-
-**Signature:** `getSubmittedAction() : FormAction`
-
-Returns the action that was submitted with the last request.
-
-### getTriggeredAction
-
-**Signature:** `getTriggeredAction() : FormAction`
-
-Returns the action that was triggered with the last request.
-
-## Method Detail
-
-## Method Details
-
-### accept
-
-**Signature:** `accept() : void`
-
-**Description:** 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
-
-**Signature:** `copyFrom(obj : Object) : void`
-
-**Description:** 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: for lists it makes it easier in the code to find the associated object, for example in case of a related action, and it allows to copy back the values from the form into the object (see 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
-
-**Signature:** `copyTo(obj : Object) : void`
-
-**Description:** 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) and copyTo(Object) 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
-
-**Signature:** `getChildCount() : Number`
-
-**Description:** Returns the number of elements in the form.
-
-**Returns:**
-
-the number of elements in the form.
-
----
-
-### getError
-
-**Signature:** `getError() : String`
-
-**Description:** 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
-
-**Signature:** `getObject() : Object`
-
-**Description:** The object that was bound to this form group.
-
-**Returns:**
-
-the bound object.
-
----
-
-### getSubmittedAction
-
-**Signature:** `getSubmittedAction() : FormAction`
-
-**Description:** 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
-
-**Signature:** `getTriggeredAction() : FormAction`
-
-**Description:** 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.
-
----

package/docs/dw_web/FormList.md

@@ -1,126 +0,0 @@
-## Package: dw.web
-
-# Class FormList
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-  - dw.web.FormGroup
-    - dw.web.FormList
-
-## Description
-
-Represents a list of forms.
-
-## Properties
-
-### selectManyItems
-
-**Type:** List (Read Only)
-
-The selected list items if the list is
- configured to support selection of items.
-
-### selectManyObjects
-
-**Type:** List (Read Only)
-
-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
-
-**Type:** FormListItem (Read Only)
-
-The default list item if the list is configured to
- support the selection of a default item.
-
-### selectOneObject
-
-**Type:** Object (Read Only)
-
-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.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSelectManyItems
-
-**Signature:** `getSelectManyItems() : List`
-
-returns the selected list items if the list is configured to support selection of items.
-
-### getSelectManyObjects
-
-**Signature:** `getSelectManyObjects() : List`
-
-Returns a list of all selected objects if the list is configured to support the selection of items.
-
-### getSelectOneItem
-
-**Signature:** `getSelectOneItem() : FormListItem`
-
-Returns the default list item if the list is configured to support the selection of a default item.
-
-### getSelectOneObject
-
-**Signature:** `getSelectOneObject() : Object`
-
-Returns the selected object if the list is configured to support the selection of a default item.
-
-## Method Detail
-
-## Method Details
-
-### getSelectManyItems
-
-**Signature:** `getSelectManyItems() : List`
-
-**Description:** 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
-
-**Signature:** `getSelectManyObjects() : List`
-
-**Description:** 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
-
-**Signature:** `getSelectOneItem() : FormListItem`
-
-**Description:** 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
-
-**Signature:** `getSelectOneObject() : Object`
-
-**Description:** 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.
-
----

package/docs/dw_web/FormListItem.md

@@ -1,48 +0,0 @@
-## Package: dw.web
-
-# Class FormListItem
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.FormElement
-  - dw.web.FormGroup
-    - dw.web.FormListItem
-
-## Description
-
-Represents an item in a form list.
-
-## Properties
-
-### itemIndex
-
-**Type:** Number (Read Only)
-
-The index of this item with the list.
-
-## Constructor Summary
-
-## Method Summary
-
-### getItemIndex
-
-**Signature:** `getItemIndex() : Number`
-
-Returns the index of this item with the list.
-
-## Method Detail
-
-## Method Details
-
-### getItemIndex
-
-**Signature:** `getItemIndex() : Number`
-
-**Description:** Returns the index of this item with the list.
-
-**Returns:**
-
-the index of this item with the list.
-
----

package/docs/dw_web/Forms.md

@@ -1,16 +0,0 @@
-## Package: dw.web
-
-# Class Forms
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.web.Forms
-
-## Description
-
-The Forms object provides access to all current forms in the session. The individual forms are retrieved as a dynamic property, for example 'forms.searchform'. It is typically retrieved from the session via Session.getForms(). But it is also available in the PipelineDictionary and can be accessed via 'pdict.CurrentForms'. Note that values stored with a form on the session are deleted if the request locale is changed during the session.
-
-## Constructor Summary
-
-## Method Summary