This topic alphabetically lists the properties that apply to the ClassDefinition class.
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).
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
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.
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.
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).
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.The text is not locale-specific to the retrieving user except for the following classes:
LocalizedStringList
object containing a collection of LocalizedString
objects, each of which
represents a locale-specific, user-readable description of a class or property.
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.
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.
ExternalIdentityList
collection of the read-only ExternalIdentity
objects
that represent the identities of replicas of this object in external repositories.
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.
ClassDefinitionSet
object, which contains a
ClassDefinition
object for each class that is an immediate
subclass of the class defined by this ClassDefinition
object.
AddOn
that installed this object. If null, this object was either created by the system or an external application.
For classes, the following conditions apply:
true
if any property on this class is going to be enabled for CBR. 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.
true
)
or not (false
).
true
) or not (false
).
If this property is false
, only the server can save the state of the object.
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.
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).
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.
PropertyDefinitionList
object containing an ordered collection of all of the
property definitions belonging to this class definition.
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
ReplicationJournalEntry
objects only, this property represents the replication group
to which the source object of the replication operation generating this journal entry belongs.
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.
ClassDefinition
object that defines the immediate superclass of the class defined
by this class definition.
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 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.
TableDefinition
object for the database table in which this ClassDefinition
or
PropertyDefinition
object resides.