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.
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Valid settings are:
(default setting): Binds the parent component version to the explicitly specified child component version. Set these required properties to create aSTATIC_CR
object with this setting:ComponentRelationship
andParentComponent
.ChildComponent
: 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 theDYNAMIC_CR VersionBindType property. This setting expects an eligible-for-binding child component version to exist; for more information on this requirement, see theChildComponent property. Set these required properties to create a
object with this setting:ComponentRelationship
,ParentComponent
, andChildComponent
.VersionBindType
: Binds the parent component version to the most recent child component version satisfying the version bind rule that has aDYNAMIC_LABEL_CR
property value matching theComponentBindingLabel
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 whenLabelBindValue
has aLabelBindValue
value andnull
has a non-ComponentBindingLabel
value. For information on the version bind rule, see thenull
property. Set these required properties to create aVersionBindType
object with this setting:ComponentRelationship
,ParentComponent
,ChildComponent
, andVersionBindType
.LabelBindValue
: Creates a component relationship between the parent component document and the URI document specified by theURICR
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 aURIValue
object with this setting:ComponentRelationship
andParentComponent
.URIValue
When you modify the
property from one setting to another, be aware that the previously set values for some properties might be lost:
- The
property applies to theURIValue
setting; the property value isURICR
for all other settings.null - The
property applies to theChildComponent
,STATIC_CR
, andDYNAMIC_CR
settings; the property value isDYNAMIC_LABEL_CR
for thenull
setting.URICR - The
property applies to theVersionBindType
andDYNAMIC_CR
settings; the property value isDYNAMIC_LABEL_CR
for all other settings.null - The
property applies to theLabelBindType
setting; the property value isDYNAMIC_LABEL_CR
for all other settings.null
For an overview of document binding, see the
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property ComponentRelationshipType As ComponentRelationshipType |
C# |
---|
ComponentRelationshipType ComponentRelationshipType { get; set; } |
C++ |
---|
property ComponentRelationshipType ComponentRelationshipType abstract { ComponentRelationshipType get(); void set(ComponentRelationshipType value); } |
J# |
---|
/** property */ public ComponentRelationshipType get_ComponentRelationshipType(); /** property */ public void set_ComponentRelationshipType(ComponentRelationshipType value); |
JScript |
---|
public function get ComponentRelationshipType() : ComponentRelationshipType public function set ComponentRelationshipType(value : ComponentRelationshipType); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 3
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ