Containable Properties

The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object.

Specifies an AnnotationSet object that contains the annotations associated with this object.

An EventSet collection of the Event objects containing the audited events that have occurred for the object.

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

An enumeration of CmHoldRelationship objects associated with this object.

A ReferentialContainmentRelationshipSet collection object containing the ReferentialContainmentRelationship objects that identify the containers of this object.

The enumeration of tasks coordinated by the Containable object. Each CmTask object in the enumeration represents a single piece of work in a business process. A CmTask object with a Coordinator property set to this Containable object is added to the enumeration value of this property.

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.

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.

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).

Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.

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.

Indicates the name of the user who last modified this 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).

Identifies the owner that exclusively holds the advisory lock on the object. This property is populated as a result of a successful call to the lock method. The value of this property is simply a custom string that has no real effect in determining the user of the lock. The owner specified by this property is not validated against any user or group known to the Content Engine. This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

The number of seconds beyond the last modified date that the server will retain a lock. This property's value is used to calculate a lock's expiration time. The property's value is populated as a result of a successful call to the lock method; however, the value can be updated by a call to updateLock. The property value is the number of seconds beyond the value in the object's DateLastModified property that the user of the lock can hold the lock on the object. The result of the calculation is measured against the current system time. The lock is considered expired when the value of the object's DateLastModified property plus the value of the LockTimeout property is less than the current system time. (All millisecond components are dropped from the calculation.) This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

Identifies the token used to signal that a lock exists on an object. The token is a unique identifier (GUID) that represents the lock. When the lock on the object is released (via unlock), the value of LockToken is set to null. (If the lock expires naturally, then the value remains unchanged.)

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.

Manages the security owner assigned to the object.

Manages the discretionary permissions assigned to the object.

Specifies 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.

Specifies the SecurityPolicy associated with the given object. The SecurityPolicy contains one or more SecurityTemplate objects that define the permissions to assign to a given object. A security template can be one of two types: a VersioningSecurityTemplate or an ApplicationSecurityTemplate. A VersioningSecurityTemplate defines permissions that will be automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate defines permissions that will be assigned to the object upon an explicit call to do so by an application program. For information on each of these types of templates, refer to their interface descriptions.

Assigning a security policy to a Document, CustomObject, or Folder object (or their subclasses) is optional.

The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.