Public Properties
Name | Description | |
---|---|---|
![]() |
AliasIds | Specifies an object containing a list of optional alias IDs for this class definition, property definition, or property template. Depending on the type of object to which it belongs, an alias ID is set equal to the PrimaryId of another property definition, the Id of another property template, or the Id of another class definition in another object store to equate the two properties or classes as being the same entity in multiple object store searches (see the class). |
![]() |
Cardinality | Specifies a 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 property when you create a new property template. When you create a property definition from a property template, its 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
For
|
![]() |
ChoiceList | Specifies a object that represents the discrete set of possible values that this property can hold. |
![]() |
ColumnId | The globally unique identifier (GUID) of the column in which the value of the property is stored. |
![]() |
CopyToReservation | A value indicating whether some particular document feature gets passed on as a default feature for the next document version. The passed-on feature can be a property value or a component relationship. When the property value is true, source document checkout causes the source feature to be replicated for the newly created document reservation object. For a For a |
![]() |
DataType | Specifies a constant, which indicates the data type of the value that an object property, choice list, or database table column can hold. For For For |
![]() |
DescriptiveText | User-readable text that describes an object. The text is not locale-specific to the retrieving user except for the following classes:
|
![]() |
DisplayName | The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class. |
![]() |
ExternalAliases | Specifies an collection of the external aliases defined for this property definition or replicable class definition. |
![]() |
Id | A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. For For a given property representation, the Id property has the following characteristics:
For a newly created document object, you can override the Id property of its associated |
![]() |
IsHidden | Indicates whether this class or property should be hidden from non-administrative users ( ) or not ( ). |
![]() |
IsNameProperty | Specifies whether the value of a property provides the name of the object instances of the class to which it belongs ( ) or not ( ). An object that has a designated name property (the property of one of its properties is set or the property of the object's class description is set) will have the designated name property's value assigned to its property. An object can have only one designated name property. |
![]() |
IsSystemOwned | Indicates whether a given class or property was originally created by the Content Engine (true), as opposed to user-created (false). |
![]() |
IsValueRequired | Indicates whether the property represented by a given property description, property definition, or property template is required to have a value (true) or not (false). If you attempt to save an object containing a property that requires a value and that property does not have a value assigned to it, an exception will result. |
![]() |
ModificationAccessRequired | Specifies the access rights that are required to change the value of a given property on the object instances on which the property occurs. To specify access rights, or combinations of access rights and levels, use the and classes in the package. You can:
|
![]() |
Name | The name for this object. For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If For a |
![]() |
PersistenceType | Specifies a constant that indicates whether a property can be made persistent (that is, have its state stored in a database). If a property can be made persistent, it must have either a dedicated column or a dedicated table in the database. |
![]() |
PrimaryId | The primary ID for this property definition, which is equal to the property of the property template on which this property definition is based. Property definitions that exist on different classes but are derived from the same property template will all have the same
|
![]() |
PropertyTemplate | Contains an object instance of a subclass ( , for example) that specifies the property template on which this property definition is based. |
![]() |
RequiresUniqueElements | Specifies whether the values of a multi-valued property must be unique (True) or not (False). |
![]() |
Settability | Specifies a constant, which indicates when the value of a property can be set. For special system property cases in which privileged write access may be granted, the property governs the property's settability for users who have access, while the property continues to indicate the property's settability for all other users. See the description of the property for these special cases. |
![]() |
SymbolicName | Represents the programmatic identifier for this class description, class definition, property description, property definition, property template, or object store. For objects in which you can set the For property template objects, changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing ( |
![]() |
TableDefinition | The object for the database table in which this or object resides. |