|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ComponentRelationship
Defines a hierarchical relationship between two documents as components in a compound document.
One document is the designated parent component (ParentComponent property) and the other is the designated child component. The child component document can be either a P8 Content Engine document (ChildComponent property) or a URI document (URIValue property). A document can be referenced by more than one instance of this class and consequently can be designated as a component in more than one relationship; this capability allows documents to be networked together to form compound documents with numerous components.
The two documents in a component relationship might be bound to each other as a result of that
relationship. Document binding means the child component document exists in the child documents
collection (ChildDocuments property) for the parent component, and the parent component document
exists in the parent documents collection (ParentDocuments property) for the child component. This
binding can be conditional; for example, it can be conditional on the value for one of the properties on
the child document matching an expected value. Also, the child component can be a URI document
instead of a Document
object. Consequently, not every component relationship results in a document
binding. For more information on component relationship types and which properties you are required
to set when you create a new ComponentRelationship
object, see
ComponentRelationshipType Property.
The two documents in a component relationship do not have to belong to the same object store. Also, these documents can continue to be used and referenced as individual documents, just as if they had never entered into a component relationship with each other.
The parent component document determines security for each instance of this class. Users
with write permission (AccessRight.WRITE
) to the parent component have the same rights to that component
relationship instance. Permission to delete a component relationship instance requires
AccessRight.DELETE
or AccessRight.UNLINK
rights on the parent component document.
Metadata
Auditable: true
Method Summary | |
---|---|
EventSet |
get_AuditedEvents()
Returns the value of the AuditedEvents property. |
Document |
get_ChildComponent()
Returns the value of the ChildComponent property. |
VersionSeries |
get_ChildVersionSeries()
Returns the value of the ChildVersionSeries property. |
ComponentCascadeDeleteAction |
get_ComponentCascadeDelete()
Returns the value of the ComponentCascadeDelete property. |
ComponentPreventDeleteAction |
get_ComponentPreventDelete()
Returns the value of the ComponentPreventDelete property. |
ComponentRelationshipType |
get_ComponentRelationshipType()
Returns the value of the ComponentRelationshipType property. |
java.lang.Integer |
get_ComponentSortOrder()
Returns the value of the ComponentSortOrder property. |
java.lang.Boolean |
get_CopyToReservation()
Returns the value of the CopyToReservation property. |
java.lang.String |
get_Creator()
Returns the value of the Creator property. |
java.util.Date |
get_DateCreated()
Returns the value of the DateCreated property. |
java.util.Date |
get_DateLastModified()
Returns the value of the DateLastModified property. |
Id |
get_Id()
Returns the value of the Id property. |
java.lang.String |
get_LabelBindValue()
Returns the value of the LabelBindValue property. |
java.lang.String |
get_LastModifier()
Returns the value of the LastModifier property. |
java.lang.String |
get_Name()
Returns the value of the Name property. |
Document |
get_ParentComponent()
Returns the value of the ParentComponent property. |
java.lang.String |
get_URIValue()
Returns the value of the URIValue property. |
VersionBindType |
get_VersionBindType()
Returns the value of the VersionBindType property. |
void |
set_ChildComponent(Document value)
Sets the value of the ChildComponent property. |
void |
set_ComponentCascadeDelete(ComponentCascadeDeleteAction value)
Sets the value of the ComponentCascadeDelete property. |
void |
set_ComponentPreventDelete(ComponentPreventDeleteAction value)
Sets the value of the ComponentPreventDelete property. |
void |
set_ComponentRelationshipType(ComponentRelationshipType value)
Sets the value of the ComponentRelationshipType property. |
void |
set_ComponentSortOrder(java.lang.Integer value)
Sets the value of the ComponentSortOrder property. |
void |
set_CopyToReservation(java.lang.Boolean value)
Sets the value of the CopyToReservation property. |
void |
set_Creator(java.lang.String value)
Sets the value of the Creator property. |
void |
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. |
void |
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. |
void |
set_LabelBindValue(java.lang.String value)
Sets the value of the LabelBindValue property. |
void |
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. |
void |
set_Name(java.lang.String value)
Sets the value of the Name property. |
void |
set_ParentComponent(Document value)
Sets the value of the ParentComponent property. |
void |
set_URIValue(java.lang.String value)
Sets the value of the URIValue property. |
void |
set_VersionBindType(VersionBindType value)
Sets the value of the VersionBindType property. |
Methods inherited from interface com.filenet.api.core.RepositoryObject |
---|
getObjectStore |
Methods inherited from interface com.filenet.api.replication.Replicable |
---|
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup |
Methods inherited from interface com.filenet.api.core.Subscribable |
---|
raiseEvent |
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject |
---|
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
EventSet get_AuditedEvents()
java.lang.String get_Creator()
void set_Creator(java.lang.String value)
java.util.Date get_DateCreated()
void set_DateCreated(java.util.Date value)
java.lang.String get_LastModifier()
void set_LastModifier(java.lang.String value)
java.util.Date get_DateLastModified()
void set_DateLastModified(java.util.Date value)
Id get_Id()
java.lang.String get_Name()
void set_Name(java.lang.String value)
Document get_ParentComponent()
void set_ParentComponent(Document value)
java.lang.Integer get_ComponentSortOrder()
void set_ComponentSortOrder(java.lang.Integer value)
Document get_ChildComponent()
void set_ChildComponent(Document value)
java.lang.Boolean get_CopyToReservation()
void set_CopyToReservation(java.lang.Boolean value)
java.lang.String get_URIValue()
void set_URIValue(java.lang.String value)
VersionSeries get_ChildVersionSeries()
VersionBindType get_VersionBindType()
void set_VersionBindType(VersionBindType value)
java.lang.String get_LabelBindValue()
void set_LabelBindValue(java.lang.String value)
ComponentRelationshipType get_ComponentRelationshipType()
void set_ComponentRelationshipType(ComponentRelationshipType value)
ComponentCascadeDeleteAction get_ComponentCascadeDelete()
void set_ComponentCascadeDelete(ComponentCascadeDeleteAction value)
ComponentPreventDeleteAction get_ComponentPreventDelete()
void set_ComponentPreventDelete(ComponentPreventDeleteAction value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |