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:

  • STATIC_CR (default setting): Binds the parent component version to the explicitly specified child component version. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent and ChildComponent.
  • DYNAMIC_CR: Binds the parent component version to the most recent child component version that satisfies the version bind rule. For information on the version bind rule, see the VersionBindType property. This setting expects an eligible-for-binding child component version to exist; for more information on this requirement, see the ChildComponent property. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent, ChildComponent, and VersionBindType.
  • DYNAMIC_LABEL_CR: Binds the parent component version to the most recent child component version satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. No binding occurs if no such child document version exists. The value comparison considers the two properties to be matching when they have the same value, or when LabelBindValue has a null value and ComponentBindingLabel has a non-null value. For information on the version bind rule, see the VersionBindType property. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent, ChildComponent, VersionBindType, and LabelBindValue.
  • URICR: Creates a component relationship between the parent component document and the URI document specified by the URIValue property. The URI can be for a P8 Content Engine document, and any other "document" a URI can refer to. Set these required properties to create a ComponentRelationship object with this setting: ParentComponent and URIValue.

When you modify the ComponentRelationshipType property from one setting to another, be aware that the previously set values for some properties might be lost:

  • The URIValue property applies to the URICR setting; the property value is null for all other settings.
  • The ChildComponent property applies to the STATIC_CR, DYNAMIC_CR, and DYNAMIC_LABEL_CR settings; the property value is null for the URICR setting.
  • The VersionBindType property applies to the DYNAMIC_CR and DYNAMIC_LABEL_CR settings; the property value is null for all other settings.
  • The LabelBindType property applies to the DYNAMIC_LABEL_CR setting; the property value is null for all other settings.

For an overview of document binding, see the IComponentRelationship interface.

Namespace:  FileNet.Api.Core
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Property ComponentRelationshipType As ComponentRelationshipType
C#
ComponentRelationshipType ComponentRelationshipType { get; set; }
Visual C++
property ComponentRelationshipType ComponentRelationshipType {
	ComponentRelationshipType get ();
	void set (ComponentRelationshipType value);
}
JavaScript
function get_componentRelationshipType();
function set_componentRelationshipType(value);

ToggleRemarks

ToggleSee Also