The IExternalPropertyDescription type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyCardinality
Specifies a 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:

  • For PropertyDescriptionObject and PropertyDefinitionObject objects only, this property can have any Cardinality constant value: SINGLE, ENUM, or LIST.
  • For all other 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:

  • For 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.
  • For all other PropertyTemplate object types, this property must have a value of SINGLE or LIST.

Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyDataType
Specifies a 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.
Public propertyDescriptiveText
User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription
  • ClassDefinition
  • PropertyTemplate
  • PropertyDefinition
Public propertyDisplayName
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality.

For ICmAuditProcessingBookmark and IAuditDefinition 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 ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness.

Public propertyMappableDirection
A 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.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyPropertyIdentity
Specifies the identity of the external property described by this external property description or for which this external property alias defines a mapping.

For ExternalPropertyDescription objects only, this string is immutable and is unique within the external class to which the external property description belongs.

ToggleSee Also