Represents the description of a class property in an external repository.


The following tables list the members exposed by IExternalPropertyDescription.

Public Properties

  Name Description
Public property Cardinality 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 property DataType Specifies a TypeID constant, which indicates the data type of the value that an object property, choice list, or database table column can hold.

For PropertyDescription, PropertyDefinition, and PropertyTemplate object types, 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 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.

Public property DescriptiveText 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 property DisplayName The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
Public property MappableDirection Specifies the direction in which the external property described by this external property description can be mapped for replication with respect to a Content Engine property.
Public property PropertyIdentity 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.

Top

See Also