Public Properties
Name | Description | |
---|---|---|
![]() |
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. |
![]() |
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 |
![]() |
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 ( ). |
![]() |
IsOrderable | Indicates whether this property can appear in the ORDER BY clause of a query. |
![]() |
IsReadOnly | Specifies whether you can modify the value of the property described by this property description ( ) or not ( ). If is , the property's value can only be changed by the server. |
![]() |
IsSearchable | Specifies whether the class or property can be used as part of the search criteria for a query. |
![]() |
IsSelectable | Specifies whether the class or property can be selected in a query result set. |
![]() |
IsSystemGenerated | Indicates whether the property described by a given property description has its value set automatically by the Content Engine server (true) or not (false). In general if is true, the described property either provides system information (for example, ) or has its value determined by the server according to the results of a method call or some other operation (for example, if you call a folder's method, the system will automatically add the newly created folder to the collection of objects returned by the 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. |
![]() |
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. |
![]() |
PrivilegedSettability | Specifies a constant, which indicates the settability of a property when an application has been granted privileged write access ( access right). Privileged write access gives an application the potential capability to set the , , , and properties, which are normally read-only. The property continues to indicate the property's settability for all other users. |
![]() |
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. The value of the property is treated in a case-insensitive manner. 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 ( |