ClassDescription Properties

Indicates whether an application can create an object instance of a given class. If this property is false, only the Content Engine server can instantiate the class.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

The default security owner for an object of a given class. This property is useful if you want a group or user other than the object's creator to have owner security rights.

The default discretionary permissions to be used when creating an instance of a given class.

The duration of the default retention period for the class defined by this class definition. The time unit (days, for example) in which the value of the DefaultRetentionPeriod property is expressed is determined by the value of the RetentionPeriodUnits property. For a new instance of the class defined by this class definition, the Content Engine server calculates the default retention date and time of the instance by adding the retention duration, expressed in the specified period units, to the date and time when the instance is created. The CmRetentionDate property of the instance is initially set to the default retention date and time, unless it is overridden.

Instead of a retention period, the DefaultRetentionPeriod property can be set to one of the following RetentionConstants constants:

• INDEFINITE: Indefinite retention period. Specifies that the instance of the class defined by this class definition can only be deleted if its CmRetentionDate property has been converted to a expiration date and time and that date and time is in the past.
• PERMANENT: Permanent retention period. Specifies that the instance of the class defined by this class definition can never be deleted.

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

The user-readable, provider-specific name of an object. This property is usually the designated 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.

Specifies whether a given class supports queries that include its subclasses (true) or not (false).

Specifies whether a given class supports queries that include descendant properties (true) or not (false). A descendant property is a property that is added to one or more subclasses of a class.

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 User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

• PropertyDescription.get_Id() is equal to PropertyTemplate.get_Id(), which is equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDefinition.get_PrimaryId().
• PropertyDefinition.get_Id() is not equal to PropertyDescription.get_Id().

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Specifies an IdList object containing the collection of all of the IDs used to identify this class description or property description. The collection includes the value of this class description or property description's Id property and the values of any assigned alias IDs.

Specifies a ClassDescriptionSet object, which contains a ClassDescription object for each class that is an immediate subclass of the class described by this ClassDescription object.

Specifies whether this class or property is enabled for full text indexing (content-based retrieval).

For classes, the following conditions apply:

• The value of this property must be set to true if any property on this class is going to be enabled for CBR.
• A value of true also enables full text indexing of any content associated with the class. (There is no content property to enable CBR.)

For properties, this property can be enabled only on Document, Annotation, CustomObject, and Folder objects.

Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).

Specifies whether you can save the state of the object instantiation of this class (true) or not (false). If this property is false, only the server can save the state of the object.

Identifies whether objects of the described class have independently settable security.

Unlike a dependently securable object, which inherits its security from a parent object, an independently securable object has its own Access Control List (ACL) that specifies its security and ensures that access rights are checked each time a user tries to access the object. As an example, a Document object is the security parent of its dependent ContentElement objects. The value of this property is true if the given object's security is independently settable (as in the case of Document) and is false if the object's security is inherited from a security parent (as in the case of a ContentElement).

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 ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Specifies the 0-based index of the PropertyDescription object in this ClassDescription object's PropertyDescriptions collection that serves as the name property for object instances of the class. If NamePropertyIndex is null, the class will not have a designated name property; in this case, the Name property of the object instantiation of the class will be set to the value of its Id property.

A list of descriptions of permissions applicable to objects of the described class.

Specifies a PropertyDescriptionList object containing a collection of the property description objects belonging to all of the subclasses of the class described by this ClassDescription object.

Specifies a PropertyDescriptionList object containing an ordered collection of all of the property descriptions belonging to this class description.

A DurationUnits constant that specifies the time unit in which the retention duration period (DefaultRetentionPeriod property of a class definition, or RetentionDurationUpdate property of a retention update policy or retention update job) is expressed. For example, if the RetentionPeriodUnits property is set to MONTHS and the DefaultRetentionPeriod property is set to 5, the retention duration period is 5 months.

This constant can have one of the following values

• YEARS
• MONTHS
• WEEKS
• DAYS
• HOURS
• MINUTES
• SECONDS

On a class description, RetentionPeriodUnits is read only.

Specifies the ClassDescription object that describes the immediate superclass of the class described by this class description.

Specifies the number of property descriptions contained in the class description that describes the immediate superclass of the class described by this class description. This value is equal to the number of properties inherited by a subclass from its superclass.

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 SymbolicName property (object store, class definition, and property template objects), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object. For class definition and property template objects, avoid assigning its symbolic name to a value beginning with one of the reserved prefixes: Cm, Dita, and RM.

For object store objects, the symbolic name for an object store must be unique within a domain.

For class definition objects, the symbolic name for a class must be unique within an object store.

For property template objects, the symbolic name for a property must be unique within a class family only. A class family is defined by a root class (for example, Document, Folder, or CustomObject) and all of its descendants. Changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing (IsCBREnabled property set to true) will require re-indexing of all objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.