The IEventClassDefinition type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAliasIds
Specifies an IdList 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 SearchScope class).
(Inherited from IClassDefinition.)
Public propertyAllowsInstances
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.
(Inherited from IClassDefinition.)
Public propertyAllowsPropertyAdditions
Specifies whether user-defined properties can be added to a class defined by a given class definition (true) or not (false).
(Inherited from IClassDefinition.)
Public propertyAllowsSubclasses
Specifies whether you can create subclasses from a class defined by a given class definition (true) or not (false).
(Inherited from IClassDefinition.)
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IClassDefinition.)
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCreator
Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from IClassDefinition.)
Public propertyDateCreated
Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

(Inherited from IClassDefinition.)
Public propertyDateLastModified
Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from IClassDefinition.)
Public propertyDefaultInstanceOwner
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.
(Inherited from IClassDefinition.)
Public propertyDefaultInstancePermissionDescriptions
A list of descriptions of default permissions to be used when creating an instance of a given class.
(Inherited from IClassDefinition.)
Public propertyDefaultInstancePermissions
The default discretionary permissions to be used when creating an instance of a given class.
(Inherited from IClassDefinition.)
Public propertyDefaultRetentionPeriod
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.
(Inherited from IClassDefinition.)
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
(Inherited from IClassDefinition.)
Public propertyDescriptiveTexts
Specifies a LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable description of a class or property.
(Inherited from IClassDefinition.)
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.

(Inherited from IClassDefinition.)
Public propertyDisplayNames
Specifies a LocalizedStringList object containing a collection of LocalizedString objects, each of which represents a locale-specific, user-readable display name for a class definition, property template, or choice.
(Inherited from IClassDefinition.)
Public propertyExternalReplicaIdentities
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.)
Public propertyId
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 IUser and IGroup 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, IUser.Id and IGroup.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.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

(Inherited from IClassDefinition.)
Public propertyImmediateSubclassDefinitions
Specifies a ClassDefinitionSet object, which contains a ClassDefinition object for each class that is an immediate subclass of the class defined by this ClassDefinition object.
(Inherited from IClassDefinition.)
Public propertyInstalledByAddOn
Indicates the AddOn that installed this object. If null, this object was either created by the system or an external application.
(Inherited from IClassDefinition.)
Public propertyIsCBREnabled
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.

(Inherited from IClassDefinition.)
Public propertyIsHidden
Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).
(Inherited from IClassDefinition.)
Public propertyIsPersistent
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.
(Inherited from IClassDefinition.)
Public propertyIsSystemOwned
Indicates whether a given class or property was originally created by the Content Engine (true), as opposed to user-created (false).

For a CmIndexDefinition object, if the object is system-owned (the value of this property is true), then the object cannot be modified or deleted.

(Inherited from IClassDefinition.)
Public propertyLastModifier
Indicates the name of the user who last modified the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

(Inherited from IClassDefinition.)
Public propertyName
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.

(Inherited from IClassDefinition.)
Public propertyOwner
Manages the security owner assigned to the object.
(Inherited from IClassDefinition.)
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
(Inherited from IClassDefinition.)
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyPropertyDefinitions
Specifies a PropertyDefinitionList object containing an ordered collection of all of the property definitions belonging to this class definition.
(Inherited from IClassDefinition.)
Public propertyProtectedPropertyCount
Specifies the number of property definitions that can neither be moved nor removed from this class definition.
(Inherited from IClassDefinition.)
Public propertyReplicationGroup
A ReplicationGroup object representing the replication group to which this replicable object belongs.

For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

(Inherited from IReplicable.)
Public propertyRetentionPeriodUnits
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.

On a class description, RetentionPeriodUnits is read only.

(Inherited from IClassDefinition.)
Public propertySuperclassDefinition
Specifies the ClassDefinition object that defines the immediate superclass of the class defined by this class definition.
(Inherited from IClassDefinition.)
Public propertySymbolicName
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 the symbolic name to a value beginning with one of the following 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 a property template object, the symbolic name need not be unique relative to the other property template objects. However, when you use a property template to create a property definition and associate it with a class, that property definition's symbolic name must be unique within the class family. 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 will propagate to the property definitions based on that template. The property definitions that have 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.

(Inherited from IClassDefinition.)
Public propertyTableDefinition
The TableDefinition object for the database table in which this ClassDefinition or PropertyDefinition object resides.
(Inherited from IClassDefinition.)
Public propertyWorkflowSubscriptions
The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object.
(Inherited from IClassDefinition.)

ToggleSee Also