This topic alphabetically lists the properties that apply to the ExternalPropertyDescription class.
Cardinality constant, which indicates whether an object property can hold a single value
(single cardinality) or a collection of multiple values (list or enumeration cardinality). You can only set the Cardinality
property when you create a new property template. When you create a property definition from a property template,
its Cardinality property will be automatically populated with the same value as that of the property template
on which it is based. Once you have instantiated an object from the class to which the property definition belongs, the
property defined by the property definition will have the specified cardinality.
For PropertyDescription and PropertyDefinition object types, this property is read-only:
PropertyDescriptionObject and PropertyDefinitionObject objects only, this
property can have any Cardinality constant value: SINGLE, ENUM, or LIST.PropertyDescription and PropertyDefinition object types, this
property must have a value of SINGLE or LIST.
For PropertyTemplate object types, this property is settable on create:
PropertyTemplateObject objects only, this property must have a value of SINGLE
or ENUM. You can only create a custom object-valued property that has single or enumeration cardinality;
list cardinality is allowed for system object-valued properties only.PropertyTemplate object types, this property must have a value of SINGLE or LIST.The Cardinality property can have one of the values in the following table.
| Name | Value | Description |
|---|---|---|
ENUM |
1 | Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects. |
LIST |
2 | Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality. |
SINGLE |
0 | Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold. |
ClassDescription object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
TypeID constant, which indicates the data type of the value that an object can hold.
For PropertyDescription, PropertyDefinition, and PropertyTemplate objects,
this property is read-only and specifies the data type of the value that an object property can hold.
Because the value of the DataType property is automatically set by the Content Engine server to correspond
to the specific object type of the PropertyDescription, PropertyDefinition,
or PropertyTemplate object, you do not need to set it when you are creating a property template or
property definition. For example, in a PropertyDescriptionBinary, PropertyDefinitionBinary,
or PropertyTemplateBinary object, the server automatically sets the DataType property
to a value of BINARY.
For ChoiceList objects, this property is settable on create and must be a LONG or
STRING constant value. This property determines whether a choice list is an integer-type choice list, which holds
integer-type choice items or a string-type choice list, which holds string-type choice items.
For ColumnDefinition objects, this property is read-only and specifies the data type of the object property
value that is stored in the represented database table column.
For CmIndexPartitionConstraint objects, this property is read-only and specifies the data type of an index partition constraint.
Only the following values are valid:
DATE: Specifies a date index partition constraint.STRING: Specifies a string index partition constraint.The DataType property can have one of the values in the following table.
| Name | Value | Description |
|---|---|---|
BINARY |
1 | Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes. |
BOOLEAN |
2 | Specifies a Boolean data type. Represents Boolean data having a value of true or false. |
DATE |
3 | Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601. |
DOUBLE |
4 | Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308. |
GUID |
5 | Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. |
LONG |
6 | Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647. |
OBJECT |
7 | Specifies an object data type. Represents an object that is instantiated from a Content Engine class. |
STRING |
8 | Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters. |
The text is not locale-specific to the retrieving user except for the following classes:
Name property of the object's class.
For CmAuditProcessingBookmark and AuditDefinition objects, this property is intended to identify client applications
that process the audit log.
For CmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object.
For AuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.
For CmAuditProcessingBookmark and AuditDefinition objects, it is recommended that you set this property.
Specify a unique value to distinguish one client application from another.
Note, however, that the server does not prevent identical display names across multiple
CmAuditProcessingBookmark or AuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.
ReplicationDirection constant that specifies the direction in which the property in an external repository that is
described by this external property description can be mapped for replication with respect to a Content Engine property.
This mapping direction can be inbound, outbound, or both.
For ExternalPropertyDescription objects only, this string is immutable and is unique within
the external class to which the external property description belongs.