@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomObjectMgr.d.ts

@@ -0,0 +1,283 @@
+import ObjectTypeDefinition = require('./ObjectTypeDefinition');
+import CustomObject = require('./CustomObject');
+import SeekableIterator = require('../util/SeekableIterator');
+import utilMap = require('../util/Map');
+
+/**
+ * Manager class which provides methods for creating, retrieving, deleting,
+ * and searching for custom objects.
+ * 
+ * To search for system objects, use dw.object.SystemObjectMgr.
+ */
+declare class CustomObjectMgr {
+    private constructor();
+    /**
+     * Returns a new custom object instance of the specified type, using the
+     * given key value. Custom object keys need to be unique for custom object
+     * type.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static createCustomObject(type: string, keyValue: string): CustomObject;
+    /**
+     * Returns a new custom object instance of the specified type, using the
+     * given key value. Custom object keys need to be unique for custom object
+     * type.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static createCustomObject(type: string, keyValue: number): CustomObject;
+    /**
+     * Returns the meta data for the given type.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static describe(type: string): ObjectTypeDefinition;
+    /**
+     * Returns all custom objects of a specific type.
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator
+     * if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * @throws IllegalArgumentException if the given type is invalid
+     * @see dw.util.SeekableIterator.close
+     */
+    static getAllCustomObjects(type: string): SeekableIterator<CustomObject>;
+    /**
+     * Returns a custom object based on it's type and unique key.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static getCustomObject(type: string, keyValue: string): CustomObject | null;
+    /**
+     * Returns a custom object based on it's type and unique key.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static getCustomObject(type: string, keyValue: number): CustomObject | null;
+    /**
+     * 
+     * 
+     * Searches for a single custom object instance.
+     * 
+     * The search can be configured using a simple query language, which provides most common filter and operator
+     * functionality.
+     * 
+     * The identifier for an attribute to use in a query condition is always the ID of the attribute as defined
+     * in the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.
+     * `custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).
+     * 
+     * Supported attribute value types with sample expression values:
+     * 
+     * - String `'String', 'Str*', 'Strin?'`
+     * - Integer `1, 3E4`
+     * - Number `1.0, 3.99E5`
+     * - Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`
+     * - DateTime
+     * `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`
+     * - Boolean `true, false`
+     * - Email `'search@demandware.com', '*@demandware.com'`
+     * - Set of String `'String', 'Str*', 'Strin?'`
+     * - Set of Integer `1, 3E4`
+     * - Set of Number `1.0, 3.99E5`
+     * - Enum of String `'String', 'Str*', 'Strin?'`
+     * - Enum of Integer `1, 3E4`
+     * 
+     * The following types of attributes are not queryable:
+     * 
+     * - Image
+     * - HTML
+     * - Text
+     * - Quantity
+     * - Password
+     * 
+     * Note, that some system attributes are not queryable by default regardless of the actual value type code.
+     * 
+     * The following operators are supported in a condition:
+     * 
+     * - `=` Equals - All types; supports NULL value (`thumbnail = NULL`)
+     * - `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)
+     * - `<` Less than - Integer, Number and Date types only
+     * - `>` Greater than - Integer, Number and Date types only
+     * - `<=` Less or equals than - Integer, Number and Date types only
+     * - `>=` Greater or equals than - Integer, Number and Date types only
+     * - `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to
+     * support substring search(`custom.country LIKE 'US*'`)
+     * - `ILIKE` Case-independent Like - String types and Email only, use to support case insensitive query
+     * (`custom.country ILIKE 'usa'`), does also support wildcards for substring matching
+     * 
+     * Conditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.
+     * `gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.
+     * 
+     * The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed
+     * object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by
+     * braces. The first Integer value must be '0', the second '1' and so on, e.g.
+     * `querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date)`
+     * 
+     * If there is more than one object matching the specified query criteria, the result is not deterministic. In order
+     * to retrieve a single object from a sorted result set it is recommended to use the following code:
+     * `queryCustomObjects("", "custom.myAttr asc", null).first()`. The method `first()` returns
+     * only the next element and closes the iterator.
+     * 
+     * This method does not consider locale specific attributes. It returns all objects by checking the default
+     * non-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom
+     * code.
+     * 
+     * Example:
+     * 
+     * - Get the custom objects using this method with non-localized attributes query.
+     * - Access the `obj.getCustom("myattr")`. It returns the localized value of the attribute.
+     * @throws IllegalArgumentException if the given type is invalid
+     */
+    static queryCustomObject(type: string, queryString: string, ...args: any[]): CustomObject;
+    /**
+     * Searches for custom object instances.
+     * 
+     * The search can be configured using a simple query language, which provides most common filter and operator
+     * functionality.
+     * 
+     * The identifier for an attribute to use in a query condition is always the ID of the attribute as defined
+     * in the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.
+     * `custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).
+     * 
+     * Supported attribute value types with sample expression values:
+     * 
+     * - String `'String', 'Str*', 'Strin?'`
+     * - Integer `1, 3E4`
+     * - Number `1.0, 3.99E5`
+     * - Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`
+     * - DateTime
+     * `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`
+     * - Boolean `true, false`
+     * - Email `'search@demandware.com', '*@demandware.com'`
+     * - Set of String `'String', 'Str*', 'Strin?'`
+     * - Set of Integer `1, 3E4`
+     * - Set of Number `1.0, 3.99E5`
+     * - Enum of String `'String', 'Str*', 'Strin?'`
+     * - Enum of Integer `1, 3E4`
+     * 
+     * The following types of attributes are not queryable:
+     * 
+     * - Image
+     * - HTML
+     * - Text
+     * - Quantity
+     * - Password
+     * 
+     * Note, that some system attributes are not queryable by default regardless of the actual value type code.
+     * 
+     * The following operators are supported in a condition:
+     * 
+     * - `=` Equals - All types; supports NULL value (`thumbnail = NULL`)
+     * - `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)
+     * - `<` Less than - Integer, Number and Date types only
+     * - `>` Greater than - Integer, Number and Date types only
+     * - `<=` Less or equals than - Integer, Number and Date types only
+     * - `>=` Greater or equals than - Integer, Number and Date types only
+     * - `LIKE` Like - String types and Email only; use if leading or trailing wildcards will be used to
+     * support substring search(`custom.country LIKE 'US*'`)
+     * - `ILIKE` Caseindependent Like - String types and Email only, use to support case insensitive query
+     * (`custom.country ILIKE 'usa'`), does also support wildcards for substring matching
+     * 
+     * Conditions can be combined using logical expressions 'AND', 'OR' and 'NOT' and nested using parenthesis e.g.
+     * `gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.
+     * 
+     * The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed
+     * object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by
+     * braces. The first Integer value must be '0', the second '1' and so on, e.g.
+     * `querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date)`
+     * 
+     * The sorting parameter is optional and may contain a comma separated list of attribute names to sort by.
+     * Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default
+     * sorting directions is ascending, if no direction was specified.
+     * 
+     * Example: `age desc, name`
+     * 
+     * Please note that specifying a localized custom attribute as the sorting attribute is currently not supported.
+     * 
+     * Sometimes it is desired to get all instances of specified type with a special sorting condition. This can be
+     * easily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty
+     * 'queryString', e.g. `queryCustomObjects("sample", "", "custom.myAttr asc")`
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator if not all of its
+     * elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * 
+     * This method does not consider locale specific attributes. It returns all objects by checking the default
+     * non-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom
+     * code.
+     * 
+     * Example:
+     * 
+     * - Get the custom objects using this method with non-localized attributes query.
+     * - Access the `obj.getCustom("myattr")`. It returns the localized value of the attribute.
+     * @throws IllegalArgumentException if the given type is invalid
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryCustomObjects(type: string, queryString: string, sortString: string | null, ...args: any[]): SeekableIterator<CustomObject>;
+    /**
+     * 
+     * 
+     * Searches for custom object instances.
+     * 
+     * The search can be configured with a map, which key-value pairs are converted into a query expression. The
+     * key-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements.
+     * 
+     * Example:
+     * 
+     * A map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows:
+     * `"name like 'tom*' and age = 66"`
+     * 
+     * The identifier for an attribute to use in a query condition is always the ID of the attribute as defined
+     * in the type definition. For custom defined attributes the prefix custom is required in the search term (e.g.
+     * `custom.color = {1}`), while for system attributes no prefix is used (e.g. `name = {4}`).
+     * 
+     * Supported attribute value types with sample expression values:
+     * 
+     * - String `'String', 'Str*', 'Strin?'`
+     * - Integer `1, 3E4`
+     * - Number `1.0, 3.99E5`
+     * - Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`
+     * - DateTime
+     * `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`
+     * - Boolean `true, false`
+     * - Email `'search@demandware.com', '*@demandware.com'`
+     * - Set of String `'String', 'Str*', 'Strin?'`
+     * - Set of Integer `1, 3E4`
+     * - Set of Number `1.0, 3.99E5`
+     * - Enum of String `'String', 'Str*', 'Strin?'`
+     * - Enum of Integer `1, 3E4`
+     * 
+     * The following types of attributes are not queryable:
+     * 
+     * - Image
+     * - HTML
+     * - Text
+     * - Quantity
+     * - Password
+     * 
+     * Note, that some system attributes are not queryable by default regardless of the actual value type code.
+     * 
+     * The sorting parameter is optional and may contain a comma separated list of attribute names to sort by.
+     * Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). Default
+     * sorting directions is ascending, if no direction was specified.
+     * 
+     * Example: `age desc, name`
+     * 
+     * Please note that specifying a localized custom attribute as the sorting attribute is currently not supported.
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator if not all of its
+     * elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * 
+     * This method does not consider locale specific attributes. It returns all objects by checking the default
+     * non-localizable attributes. Any locale specific filtering after fetching the objects must be done by other custom
+     * code.
+     * 
+     * Example:
+     * 
+     * - Get the custom objects using this method with non-localized attributes query.
+     * - Access the `obj.getCustom("myattr")`. It returns the localized value of the attribute.
+     * @throws IllegalArgumentException if the given type is invalid
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryCustomObjects(type: string, queryAttributes: utilMap<any, any>, sortString: string | null): SeekableIterator<CustomObject>;
+    /**
+     * Removes a given custom object.
+     */
+    static remove(object: CustomObject): void;
+}
+
+export = CustomObjectMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/Extensible.d.ts

@@ -0,0 +1,27 @@
+import CustomAttributes = require('./CustomAttributes');
+import ObjectTypeDefinition = require('./ObjectTypeDefinition');
+
+/**
+ * Base class alternative to ExtensibleObject for objects customizable through the metadata system.
+ * Similar to ExtensibleObject: the describe method provides access to the related object-type metadata.
+ * The getCustom method is the central point to retrieve and store the objects attribute
+ * values themselves.
+ */
+declare abstract class Extensible {
+    /**
+     * Returns the custom attributes for this object.
+     */
+    readonly custom: CustomAttributes;
+    /**
+     * Returns the meta data of this object. If no meta data is available the
+     * method returns null. The returned ObjectTypeDefinition can be used to
+     * retrieve the metadata for any of the custom attributes.
+     */
+    describe(): ObjectTypeDefinition;
+    /**
+     * Returns the custom attributes for this object.
+     */
+    getCustom(): CustomAttributes;
+}
+
+export = Extensible;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ExtensibleObject.d.ts

@@ -0,0 +1,36 @@
+import PersistentObject = require('./PersistentObject');
+import CustomAttributes = require('./CustomAttributes');
+import ObjectTypeDefinition = require('./ObjectTypeDefinition');
+
+/**
+ * Base class for all persistent business objects in Commerce Cloud Digital that
+ * are customizable through the metadata system. All objects in Digital
+ * that have custom attributes derive from ExtensibleObject including
+ * both system-defined and custom objects. The describe() method provides access
+ * to the related object-type metadata. The method getCustom() is the central
+ * point to retrieve and store the objects attribute values themselves.
+ */
+declare class ExtensibleObject<T extends CustomAttributes> extends PersistentObject {
+    /**
+     * Returns the custom attributes for this object. The returned object is
+     * used for retrieving and storing attribute values. See
+     * dw.object.CustomAttributes for a detailed example of the syntax for
+     * working with custom attributes.
+     */
+    readonly custom: T;
+    /**
+     * Returns the meta data of this object. If no meta data is available the
+     * method returns null. The returned ObjectTypeDefinition can be used to
+     * retrieve the metadata for any of the custom attributes.
+     */
+    describe(): ObjectTypeDefinition;
+    /**
+     * Returns the custom attributes for this object. The returned object is
+     * used for retrieving and storing attribute values. See
+     * dw.object.CustomAttributes for a detailed example of the syntax for
+     * working with custom attributes.
+     */
+    getCustom(): T;
+}
+
+export = ExtensibleObject;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/Note.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Represents a note that can be attached to any persistent object
+ * that supports this feature.
+ */
+declare class Note {
+    /**
+     * Return the login ID of user that is stored in the session at the time
+     * the note is created.
+     */
+    readonly createdBy: string;
+    /**
+     * Return the date and time that the note was created.  This is usually
+     * set by the system, but may be specified if the note is generated
+     * via an import.
+     */
+    readonly creationDate: Date;
+    /**
+     * Return the subject of the note.
+     */
+    readonly subject: string;
+    /**
+     * Return the text of the note.
+     */
+    readonly text: string;
+    private constructor();
+    /**
+     * Return the login ID of user that is stored in the session at the time
+     * the note is created.
+     */
+    getCreatedBy(): string;
+    /**
+     * Return the date and time that the note was created.  This is usually
+     * set by the system, but may be specified if the note is generated
+     * via an import.
+     */
+    getCreationDate(): Date;
+    /**
+     * Return the subject of the note.
+     */
+    getSubject(): string;
+    /**
+     * Return the text of the note.
+     */
+    getText(): string;
+}
+
+export = Note;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ObjectAttributeDefinition.d.ts

@@ -0,0 +1,239 @@
+import Collection = require('../util/Collection');
+import ObjectAttributeGroup = require('./ObjectAttributeGroup');
+import ObjectTypeDefinition = require('./ObjectTypeDefinition');
+import ObjectAttributeValueDefinition = require('./ObjectAttributeValueDefinition');
+
+/**
+ * Represents the definition of an object's attribute.
+ */
+declare class ObjectAttributeDefinition {
+    /**
+     * Boolean value type.
+     */
+    static readonly VALUE_TYPE_BOOLEAN = 8;
+    /**
+     * Date value type.
+     */
+    static readonly VALUE_TYPE_DATE = 6;
+    /**
+     * Date and Time value type.
+     */
+    static readonly VALUE_TYPE_DATETIME = 11;
+    /**
+     * Email value type.
+     */
+    static readonly VALUE_TYPE_EMAIL = 12;
+    /**
+     * Enum of int value type.
+     */
+    static readonly VALUE_TYPE_ENUM_OF_INT = 31;
+    /**
+     * Enum of String value type.
+     */
+    static readonly VALUE_TYPE_ENUM_OF_STRING = 33;
+    /**
+     * HTML value type.
+     */
+    static readonly VALUE_TYPE_HTML = 5;
+    /**
+     * Image value type.
+     */
+    static readonly VALUE_TYPE_IMAGE = 7;
+    /**
+     * int value type.
+     */
+    static readonly VALUE_TYPE_INT = 1;
+    /**
+     * Money value type.
+     */
+    static readonly VALUE_TYPE_MONEY = 9;
+    /**
+     * Number value type.
+     */
+    static readonly VALUE_TYPE_NUMBER = 2;
+    /**
+     * Password value type.
+     */
+    static readonly VALUE_TYPE_PASSWORD = 13;
+    /**
+     * Quantity value type.
+     */
+    static readonly VALUE_TYPE_QUANTITY = 10;
+    /**
+     * Set of int value type.
+     */
+    static readonly VALUE_TYPE_SET_OF_INT = 21;
+    /**
+     * Set of Number value type.
+     */
+    static readonly VALUE_TYPE_SET_OF_NUMBER = 22;
+    /**
+     * Set of String value type.
+     */
+    static readonly VALUE_TYPE_SET_OF_STRING = 23;
+    /**
+     * String value type.
+     */
+    static readonly VALUE_TYPE_STRING = 3;
+    /**
+     * Text value type.
+     */
+    static readonly VALUE_TYPE_TEXT = 4;
+    /**
+     * Returns the ID of the attribute definition.
+     */
+    readonly ID: string;
+    /**
+     * Returns all attribute groups the attribute is assigned to.
+     */
+    readonly attributeGroups: Collection<ObjectAttributeGroup>;
+    /**
+     * Return the default value for the attribute or null if none is defined.
+     */
+    readonly defaultValue: ObjectAttributeValueDefinition | null;
+    /**
+     * Returns the display name for the attribute, which can be used in the
+     * user interface.
+     */
+    readonly displayName: string;
+    /**
+     * Identifies if the attribute represents the primary key of the object.
+     */
+    readonly key: boolean;
+    /**
+     * Checks if this attribute is mandatory.
+     */
+    readonly mandatory: boolean;
+    /**
+     * 
+     * Returns `true` if the attribute can have multiple values.
+     * 
+     * Attributes of the following types are multi-value capable:
+     * 
+     * - VALUE_TYPE_SET_OF_INT
+     * - VALUE_TYPE_SET_OF_NUMBER
+     * - VALUE_TYPE_SET_OF_STRING
+     * 
+     * Additionally, attributes of the following types can be multi-value
+     * enabled:
+     * 
+     * - VALUE_TYPE_ENUM_OF_INT
+     * - VALUE_TYPE_ENUM_OF_STRING
+     */
+    readonly multiValueType: boolean;
+    /**
+     * Returns the object type definition in which this attribute is defined.
+     */
+    readonly objectTypeDefinition: ObjectTypeDefinition;
+    /**
+     * Returns `true` if the attribute is of type 'Set of'.
+     * @deprecated Use isMultiValueType instead.
+     */
+    readonly setValueType: boolean;
+    /**
+     * Indicates if the attribute is a pre-defined system attribute
+     * or a custom attribute.
+     */
+    readonly system: boolean;
+    /**
+     * Returns the attribute's unit representation such as
+     * inches for length or pounds for weight. The value returned by
+     * this method is based on the attribute itself.
+     */
+    readonly unit: string;
+    /**
+     * Returns a code for the data type stored in the attribute. See constants
+     * defined in this class.
+     */
+    readonly valueTypeCode: number;
+    /**
+     * Returns the list of attribute values. In the user interface only the
+     * values specified in this list should be offered as valid input values.
+     * 
+     * The collection contains instances of ObjectAttributeValueDefinition.
+     */
+    readonly values: Collection<ObjectAttributeValueDefinition> | null;
+    private constructor();
+    /**
+     * Returns all attribute groups the attribute is assigned to.
+     */
+    getAttributeGroups(): Collection<ObjectAttributeGroup>;
+    /**
+     * Return the default value for the attribute or null if none is defined.
+     */
+    getDefaultValue(): ObjectAttributeValueDefinition | null;
+    /**
+     * Returns the display name for the attribute, which can be used in the
+     * user interface.
+     */
+    getDisplayName(): string;
+    /**
+     * Returns the ID of the attribute definition.
+     */
+    getID(): string;
+    /**
+     * Returns the object type definition in which this attribute is defined.
+     */
+    getObjectTypeDefinition(): ObjectTypeDefinition;
+    /**
+     * Returns the attribute's unit representation such as
+     * inches for length or pounds for weight. The value returned by
+     * this method is based on the attribute itself.
+     */
+    getUnit(): string;
+    /**
+     * Returns a code for the data type stored in the attribute. See constants
+     * defined in this class.
+     */
+    getValueTypeCode(): number;
+    /**
+     * Returns the list of attribute values. In the user interface only the
+     * values specified in this list should be offered as valid input values.
+     * 
+     * The collection contains instances of ObjectAttributeValueDefinition.
+     */
+    getValues(): Collection<ObjectAttributeValueDefinition> | null;
+    /**
+     * Identifies if the attribute represents the primary key of the object.
+     */
+    isKey(): boolean;
+    /**
+     * Checks if this attribute is mandatory.
+     */
+    isMandatory(): boolean;
+    /**
+     * 
+     * Returns `true` if the attribute can have multiple values.
+     * 
+     * Attributes of the following types are multi-value capable:
+     * 
+     * - VALUE_TYPE_SET_OF_INT
+     * - VALUE_TYPE_SET_OF_NUMBER
+     * - VALUE_TYPE_SET_OF_STRING
+     * 
+     * Additionally, attributes of the following types can be multi-value
+     * enabled:
+     * 
+     * - VALUE_TYPE_ENUM_OF_INT
+     * - VALUE_TYPE_ENUM_OF_STRING
+     */
+    isMultiValueType(): boolean;
+    /**
+     * Returns `true` if the attribute is of type 'Set of'.
+     * @deprecated Use isMultiValueType instead.
+     */
+    isSetValueType(): boolean;
+    /**
+     * Indicates if the attribute is a pre-defined system attribute
+     * or a custom attribute.
+     */
+    isSystem(): boolean;
+    /**
+     * Returns a boolean flag indicating whether or not values of this attribute
+     * definition should be encoded using the encoding="off" flag in ISML
+     * templates.
+     */
+    requiresEncoding(): boolean;
+}
+
+export = ObjectAttributeDefinition;