The IComponentRelationship 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.
|
![]() | ChildComponent |
The Document object designated as the child in a component relationship.
This property applies when the ComponentRelationshipType property setting is STATIC_CR, DYNAMIC_CR, or DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null. For a URI component relationship type, you designate the child component by setting the URIValue property. For a ComponentRelationship object whose relationship type is STATIC_CR, set the value of this property to the specific document version to bind to the parent component document. For a ComponentRelationship object whose relationship type is DYNAMIC_CR, some version of the child document must be eligible-for-binding; otherwise, calling the Save method on the ComponentRelationship object throws an exception. For example, a major version of the document must exist when the version bind rule specifies only major versions can be bound. For information on the version bind rule, see the VersionBindType property. When you call the Save method, the ChildComponent property is automatically updated to reflect the actual document version bound. For a ComponentRelationship object whose relationship type is DYNAMIC_LABEL_CR, no version of the child document need be eligible-for-binding. When you call the Save method, the value of the ChildComponent property is automatically updated to null or to the actual document version bound. This bound version is the most recent version of the child document satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. For more information on document binding, see the ComponentRelationshipType property. Note that, when the ChildComponent property value has been updated to null, you can still determine the child document for this relationship by using the ChildVersionSeries property. |
![]() | ChildVersionSeries |
The VersionSeries object that is the version series of the child component document.
Retrieving this property's value is equivalent to calling get_ChildComponent().get_VersionSeries().
This property applies when the ComponentRelationshipType property setting is DYNAMIC_CR
or DYNAMIC_LABEL_CR; otherwise, the property value is null.
|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ComponentCascadeDelete |
The setting for controlling the deletion of the child component document as an automatic response
to the deletion of the parent component document. The ComponentCascadeDeleteAction
enumeration has constants defined for the component cascade delete settings.
Valid settings are:
|
![]() | ComponentPreventDelete |
The setting for the delete behavior for parent and child components. The prevention settings
protect a document from deletion by causing an exception to be thrown on a deletion attempt.
The ComponentPreventDeleteAction
enumeration has constants defined for the component prevent delete settings.
Valid settings are:
|
![]() | ComponentRelationshipType |
The setting that determines the type of component relationship between a child document and parent document.
The ComponentRelationshipType
enumeration has constants defined for the relationship type settings.
Valid settings are:
When you modify the ComponentRelationshipType property from one setting to another, be aware that the previously set values for some properties might be lost:
For an overview of document binding, see the IComponentRelationship interface. |
![]() | ComponentSortOrder |
The ascending sort order number that determines the position of this ComponentRelationship
object within the ChildRelationships
collection as well as the position of the child component document within the
ChildDocuments collection.
These collections belong to the parent component document. Relative to any other object having the
same sort order number, the binary value of the ComponentRelationship object's Id
property determines the ascending sort order position for this object and the associated child component.
This property cannot be set to null. For a new ComponentRelationship object with no explicitly set component sort order, calling the Save method on the object assigns a value to this property equal to the highest component sort order in the ChildRelationships collection plus 1000. For example, if you did not explicitly set the ComponentSortOrder property for any ComponentRelationship objects within the collection, the first object added to the ChildRelationships collection has a component sort order of 1000; the second, 2000; the third, 3000; and so on. |
![]() | CopyToReservation |
A value indicating whether some particular document feature gets passed on as a default feature for the next document version.
The passed-on feature can be a property value or a component relationship. When the CopyToReservation property
value is true, source document checkout causes the source feature to be replicated for the newly created document reservation object.
For a IPropertyDefinition object, a value indicating whether the value of the property defined by this property definition should be copied, during checkout, from the source document to the newly created reservation object. For a IPropertyDescription object, CopyToReservation is read only. For a IComponentRelationship object, a value indicating whether this object gets copied, during checkout of the parent component source document, for the newly created reservation object. The reservation object becomes the parent component for the new copy of this IComponentRelationship object. Consequently, both the reservation object and the source document have an equivalent component relationship with the same child document. Note that the reservation object behaves like any other document with respect to compound document properties and relationships. |
![]() | Creator |
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. |
![]() | 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.
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.
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.) |
![]() | 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}.
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. |
![]() | LabelBindValue |
The value matched against the value of the ComponentBindingLabel property on a child component document
version that determines whether that version gets bound in a component relationship of type DYNAMIC_LABEL_CR.
For all other component relationship types the value of this property is null. For more information, see the
ComponentRelationshipType property.
|
![]() | LastModifier |
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). |
![]() | Name |
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. |
![]() | ParentComponent |
The Document object designated as the parent in a component relationship. The setting for
the CompoundDocumentState property on this parent Document object must be
COMPOUND_DOCUMENT. Also, you must have link rights (AccessRight.LINK) on the document.
|
![]() | 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. |
![]() | URIValue |
The URI address for the document designated as the child in a component relationship. This property
applies when the ComponentRelationshipType
property setting is URICR. For other component relationship types, you designate the child
component by setting the ChildComponent
property. If the ComponentRelationshipType property is set to anything other than URICR,
the value of the URIValue property is null. Any String value can be
entered into this property; the value does not have to be a valid URI address.
|
![]() | VersionBindType |
The setting for selecting the version bind rule in effect; this rule partly determines the child component document
version bound with the parent component for component relationship types of DYNAMIC_CR and
DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null.
(For information on document binding specifics, see the
ComponentRelationshipType property.)
The VersionBindType enumeration has
constants defined for the bind type settings.
Valid settings are:
|