sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_object/ObjectAttributeGroup.md

@@ -1,170 +0,0 @@
-## Package: dw.object
-
-# Class ObjectAttributeGroup
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.ObjectAttributeGroup
-
-## Description
-
-Represents a group of object attributes.
-
-## Properties
-
-### attributeDefinitions
-
-**Type:** Collection (Read Only)
-
-All attribute definitions for this group. The collection
- may contain both system attribute definition as well as custom
- attribute definitions.
-
-### description
-
-**Type:** String (Read Only)
-
-The description of this group in the current locale.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name of this group.
-
-### ID
-
-**Type:** String (Read Only)
-
-The ID of this group.
-
-### objectTypeDefinition
-
-**Type:** ObjectTypeDefinition (Read Only)
-
-The object type definition to which this attribute group
- belongs.
-
-### system
-
-**Type:** boolean (Read Only)
-
-Identifies if this is an sytem or a custom attribute group. A system
- attribute group is pre-defined and can not be deleted.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAttributeDefinitions
-
-**Signature:** `getAttributeDefinitions() : Collection`
-
-Returns all attribute definitions for this group.
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the description of this group in the current locale.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name of this group.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the ID of this group.
-
-### getObjectTypeDefinition
-
-**Signature:** `getObjectTypeDefinition() : ObjectTypeDefinition`
-
-Returns the object type definition to which this attribute group belongs.
-
-### isSystem
-
-**Signature:** `isSystem() : boolean`
-
-Identifies if this is an sytem or a custom attribute group.
-
-## Method Detail
-
-## Method Details
-
-### getAttributeDefinitions
-
-**Signature:** `getAttributeDefinitions() : Collection`
-
-**Description:** Returns all attribute definitions for this group. The collection may contain both system attribute definition as well as custom attribute definitions.
-
-**Returns:**
-
-all attribute definitions for this group.
-
----
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the description of this group in the current locale.
-
-**Returns:**
-
-the display name of this group.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the display name of this group.
-
-**Returns:**
-
-the display name of this group.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the ID of this group.
-
-**Returns:**
-
-the ID of this group.
-
----
-
-### getObjectTypeDefinition
-
-**Signature:** `getObjectTypeDefinition() : ObjectTypeDefinition`
-
-**Description:** Returns the object type definition to which this attribute group belongs.
-
-**Returns:**
-
-the object type definition to which this attribute group belongs.
-
----
-
-### isSystem
-
-**Signature:** `isSystem() : boolean`
-
-**Description:** Identifies if this is an sytem or a custom attribute group. A system attribute group is pre-defined and can not be deleted.
-
-**Returns:**
-
-true if this is a system attribute group, false otherwise.
-
----

package/docs/dw_object/ObjectAttributeValueDefinition.md

@@ -1,72 +0,0 @@
-## Package: dw.object
-
-# Class ObjectAttributeValueDefinition
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.ObjectAttributeValueDefinition
-
-## Description
-
-Represents the value definition associated with an object attribute.
-
-## Properties
-
-### displayValue
-
-**Type:** String (Read Only)
-
-A display name that can be used to present this value in
- the user interface. For example, the value might be '1' but the display
- name might be 'Order Exported'.
-
-### value
-
-**Type:** Object (Read Only)
-
-The actual value for the attribute.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDisplayValue
-
-**Signature:** `getDisplayValue() : String`
-
-Returns a display name that can be used to present this value in the user interface.
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-Returns the actual value for the attribute.
-
-## Method Detail
-
-## Method Details
-
-### getDisplayValue
-
-**Signature:** `getDisplayValue() : String`
-
-**Description:** Returns a display name that can be used to present this value in the user interface. For example, the value might be '1' but the display name might be 'Order Exported'.
-
-**Returns:**
-
-a display name that can be used to present this value in the user interface.
-
----
-
-### getValue
-
-**Signature:** `getValue() : Object`
-
-**Description:** Returns the actual value for the attribute.
-
-**Returns:**
-
-the actual value for the attribute.
-
----

package/docs/dw_object/ObjectTypeDefinition.md

@@ -1,216 +0,0 @@
-## Package: dw.object
-
-# Class ObjectTypeDefinition
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.ObjectTypeDefinition
-
-## Description
-
-The class provides access to the meta data of a system object or custom object. A short example should suffice to demonstrate how this metadata can be used in a script: var co : CustomObject = CustomObjectMgr.getCustomObject("sample", "MyCustomObject"); // get the object type definition var typeDef : ObjectTypeDefinition = co.describe(); // get the custom object attribute definition for name "enumIntValue" var attrDef : ObjectAttributeDefinition = typeDef.getCustomAttributeDefinition( "enumIntValue" ); // get the collection of object attribute value definitions var valueDefs : Collection = attrDef.getValues(); // return function if there are no object attribute value definitions if(valueDefs.isEmpty()) { return; } var displayValue : String; // loop over object attribute value definitions collection for each ( var valueDef : ObjectAttributeValueDefinition in valueDefs ) { if( valueDef.getValue() == co.custom.intValue ) { displayValue = valueDef.getDisplayValue(); break; } }
-
-## Properties
-
-### attributeDefinitions
-
-**Type:** Collection (Read Only)
-
-A collection of all declared attributes for the object.
- The collection contains both system and custom attributes. There might
- be system and custom attribute with identical names. So the name of the
- attribute is not a uniqueness criteria. Additional the isCustom() flag
- must be checked.
-
-### attributeGroups
-
-**Type:** Collection (Read Only)
-
-A collection of all declared attribute groups. A attribute group
- is a collection of attribute, which are typically displayed together as
- a visual group.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name of the definition, which can be used in the
- user interface.
-
-### ID
-
-**Type:** String (Read Only)
-
-The type id of the business objects.
-
-### system
-
-**Type:** boolean (Read Only)
-
-Identifies if this object definition is for a system type or a custom
- type.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAttributeDefinitions
-
-**Signature:** `getAttributeDefinitions() : Collection`
-
-Returns a collection of all declared attributes for the object.
-
-### getAttributeGroup
-
-**Signature:** `getAttributeGroup(name : String) : ObjectAttributeGroup`
-
-Returns the attribute group with the given name within this object type definition.
-
-### getAttributeGroups
-
-**Signature:** `getAttributeGroups() : Collection`
-
-Returns a collection of all declared attribute groups.
-
-### getCustomAttributeDefinition
-
-**Signature:** `getCustomAttributeDefinition(name : String) : ObjectAttributeDefinition`
-
-Returns the custom attribute definition with the given name.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name of the definition, which can be used in the user interface.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the type id of the business objects.
-
-### getSystemAttributeDefinition
-
-**Signature:** `getSystemAttributeDefinition(name : String) : ObjectAttributeDefinition`
-
-Returns the system attribute definition with the given name.
-
-### isSystem
-
-**Signature:** `isSystem() : boolean`
-
-Identifies if this object definition is for a system type or a custom type.
-
-## Method Detail
-
-## Method Details
-
-### getAttributeDefinitions
-
-**Signature:** `getAttributeDefinitions() : Collection`
-
-**Description:** Returns a collection of all declared attributes for the object. The collection contains both system and custom attributes. There might be system and custom attribute with identical names. So the name of the attribute is not a uniqueness criteria. Additional the isCustom() flag must be checked.
-
-**Returns:**
-
-a collection of all declared attributes for the object.
-
----
-
-### getAttributeGroup
-
-**Signature:** `getAttributeGroup(name : String) : ObjectAttributeGroup`
-
-**Description:** Returns the attribute group with the given name within this object type definition.
-
-**Parameters:**
-
-- `name`: The name of the attribute scope to return.
-
-**Returns:**
-
-The matching attribute scope or null if no such scope exists.
-
----
-
-### getAttributeGroups
-
-**Signature:** `getAttributeGroups() : Collection`
-
-**Description:** Returns a collection of all declared attribute groups. A attribute group is a collection of attribute, which are typically displayed together as a visual group.
-
-**Returns:**
-
-a collection of all declared attribute groups.
-
----
-
-### getCustomAttributeDefinition
-
-**Signature:** `getCustomAttributeDefinition(name : String) : ObjectAttributeDefinition`
-
-**Description:** Returns the custom attribute definition with the given name. The method returns null if no custom attribute is defined with that name.
-
-**Parameters:**
-
-- `name`: The unique name of the custom attribute definition within the object type.
-
-**Returns:**
-
-The matching attribute definition or null in case no such definition exists.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the display name of the definition, which can be used in the user interface.
-
-**Returns:**
-
-the display name of the definition, which can be used in the user interface.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the type id of the business objects.
-
-**Returns:**
-
-the type id of the business objects.
-
----
-
-### getSystemAttributeDefinition
-
-**Signature:** `getSystemAttributeDefinition(name : String) : ObjectAttributeDefinition`
-
-**Description:** Returns the system attribute definition with the given name. The method returns null if no system attribute is defined with that name. Only system objects have system attributes. A CustomObject has no system attributes and so the method will always return null for a CustomObject.
-
-**Parameters:**
-
-- `name`: The unique name of the custom attribute definition within the object type.
-
-**Returns:**
-
-The matching attribute definition or null in case no such definition exists.
-
----
-
-### isSystem
-
-**Signature:** `isSystem() : boolean`
-
-**Description:** Identifies if this object definition is for a system type or a custom type.
-
-**Returns:**
-
-true if this object definition is for a system type, false otherwise.
-
----

package/docs/dw_object/PersistentObject.md

@@ -1,94 +0,0 @@
-## Package: dw.object
-
-# Class PersistentObject
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-
-## Description
-
-Common base class for all objects in Commerce Cloud Digital that have an identity and can be stored and retrieved. Each entity is identified by a unique universal identifier (a UUID).
-
-## Properties
-
-### creationDate
-
-**Type:** Date (Read Only)
-
-The date that this object was created.
-
-### lastModified
-
-**Type:** Date (Read Only)
-
-The date that this object was last modified.
-
-### UUID
-
-**Type:** String (Read Only)
-
-The unique universal identifier for this object.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCreationDate
-
-**Signature:** `getCreationDate() : Date`
-
-Returns the date that this object was created.
-
-### getLastModified
-
-**Signature:** `getLastModified() : Date`
-
-Returns the date that this object was last modified.
-
-### getUUID
-
-**Signature:** `getUUID() : String`
-
-Returns the unique universal identifier for this object.
-
-## Method Detail
-
-## Method Details
-
-### getCreationDate
-
-**Signature:** `getCreationDate() : Date`
-
-**Description:** Returns the date that this object was created.
-
-**Returns:**
-
-the date that this object was created.
-
----
-
-### getLastModified
-
-**Signature:** `getLastModified() : Date`
-
-**Description:** Returns the date that this object was last modified.
-
-**Returns:**
-
-the date that this object was last modified.
-
----
-
-### getUUID
-
-**Signature:** `getUUID() : String`
-
-**Description:** Returns the unique universal identifier for this object.
-
-**Returns:**
-
-the unique universal identifier for this object.
-
----

package/docs/dw_object/SimpleExtensible.md

@@ -1,46 +0,0 @@
-## Package: dw.object
-
-# Class SimpleExtensible
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.SimpleExtensible
-
-## Description
-
-Base class alternative to ExtensibleObject for customizable objects which do not rely on the metadata system. Unlike Extensible any custom attributes can be set on the fly and are not checked against an available list. Similar to Extensible method getCustom() is the central point to retrieve and store the objects attribute values.
-
-## Properties
-
-### custom
-
-**Type:** CustomAttributes (Read Only)
-
-The custom attributes for this object.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCustom
-
-**Signature:** `getCustom() : CustomAttributes`
-
-Returns the custom attributes for this object.
-
-## Method Detail
-
-## Method Details
-
-### getCustom
-
-**Signature:** `getCustom() : CustomAttributes`
-
-**Description:** Returns the custom attributes for this object.
-
-**Returns:**
-
-the custom attributes for this object.
-
----