The IReferentialContainmentRelationship type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from IRelationship.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | CmIsMarkedForDeletion |
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.
(Inherited from IRelationship.)Objects marked for deletion are represented by a ICmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database). See Recovery Bin Concepts. |
![]() | ContainmentName |
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:
The following characters are not allowed:
For an Event object generated from the IFileEvent and IUnfileEvent 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 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 uniquifier to the the containment name, as follows:
|
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from IRelationship.)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. |
![]() | DateCreated |
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.
(Inherited from IRelationship.)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. |
![]() | DateLastModified |
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.
(Inherited from IRelationship.)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). |
![]() | ExternalReplicaIdentities |
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.) |
![]() | Head |
An IndependentlyPersistableObject instance that participates in a binary relationship as the logical head (containee) in a
relationship between two objects.
(Inherited from IRelationship.)For a DynamicReferentialContainmentRelationship object, the head is always a Versionable object. 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. |
![]() | Id |
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}.
(Inherited from IRelationship.)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:
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. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from IRelationship.)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). |
![]() | Name |
The name for this object.
(Inherited from IRelationship.)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. |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ReplicationGroup |
A ReplicationGroup object representing the replication group to
which this replicable object belongs.
(Inherited from IReplicable.)For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs. |
![]() | Tail |
An IndependentlyPersistableObject instance that participates in a binary relationship as the logical tail between two objects.
(Inherited from IRelationship.)For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is always a Folder object. For a Link object, this can be any subclass of IndependentObject. |