ReferentialContainmentRelationship Properties

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.

Indicates whether the object is marked (flagged) for deletion. If true, the object is the original object explicitly marked for deletion by a user, or the object is referenced by the original object through an object-valued property (OVP), and, therefore, was marked for deletion by the server.

Objects marked for deletion are represented by a CmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database).

See Recovery Bin Concepts

The name of the contained object.

For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is the name of the Head object in the relationship. The default value is supplied as follows:

• If the Head object has a MimeType property (in other words, the Head object is a Document), and if both the Name and MimeType properties of the Head object are present and not zero length, then the default value is Name.FileExtension. Content Engine maps the MIME type of the Head object to a file extension based on the mimetypes.properties file to determine FileExtension. If an apparent file extension is already present in the value of the Name property, then the default is the Name value of the Head object (no FileExtension is appended). If the value of the MimeType property does not map to any file extension, then no FileExtension is appended. In all cases, invalid characters (see list below) are removed from the Name value, and the Name value is truncated to 255 characters.
• If the MimeType property value is not present, the default is the Name value of the Head object. Invalid characters are removed from the Name value, and the Name value is truncated to 255 characters.
• If the Name value is not found, the Id value of the Head object is used.

The following characters are not allowed:

    \  /  :  *  ?  "  <  >  | 

For an Event object generated from the FileEvent and UnfileEvent classes, the value of this property is the name of the Containable object that was added or removed, respectively.

In the following scenarios, the server looks for naming collisions and makes the containment name unique:

• If AutoUniqueName.AUTO_UNIQUE is set when the object is filed. This setting should be used with caution, as described in Class AutoUniqueName.
• If an object that is filed in a folder is marked for deletion, the server modifies the containment name in any relationship objects referenced by the object marked for deletion. This is done to prevent a collision with any new object filed into the same folder, using the same containment name. If the object is later restored, the server attempts to change the containment names back to their original values (before the object was marked for deletion). For more information about marking objects for deletion, see Recovery Bin Concepts.

If a naming collision is detected when AutoUniqueName.AUTO_UNIQUE is set, or when an object that's marked for deletion object is restored, the server resolves the conflict by appending a unique suffix to the the containment name, as follows:

• The server first iterates a set of serial integers to create a unique name with a parenthesized number, such as "myDocument(14)".
• If a unique name is still not found, the server appends a tilde followed by five random characters to the containment name, such as "myDocument~Ae7Hq".

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.

An IndependentlyPersistableObject instance that participates in a binary relationship as the logical head (containee) in a relationship between two objects.

For a DynamicReferentialContainmentRelationship object, the head is always a Versionable object representing the current document version.

For a ReferentialContainmentRelationship object, the head can be any of the Containable subclasses (such as a CustomObject, Document, or Folder object). In this case, when the head is a Document object, it represents a specific document version.

For a Link object, this property can specify any object that is a subclass of the IndependentObject base 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.

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

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

An IndependentlyPersistableObject instance that participates in a binary relationship as the logical tail between two objects.

For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is always a Folder object.

For a Link object, this can be any subclass of IndependentObject.

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.