IDocumentsRelationship¶
- class IDocumentsRelationship¶
Bases:
ImpactCOMWrapperBase- Summary:
Represents a unique relationship between an IDocument and another Impact object or external object for the documents within a collection.
- Remarks:
Introduced in Impact 9.0.0.83.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property as_string¶
Gets as_string.
- Summary:
Gets the relationship type and object as a string.
- Returns:
The value of as_string.
- Return type:
as_string (str)
- property external_type¶
Gets external_type.
- Summary:
A unique identifier for the type of external object being referenced.
- Remarks:
This property is only applicable when Relationship is drExternal.
- Returns:
The value of external_type.
- Return type:
external_type (str)
- property object_id¶
Gets object_id.
- Summary:
A unique identifier for the referenced object.
- Remarks:
For most internal Impact objects the object_id is the primary key of the associated object. When Relationship is drExternal references use either an integer or string object_id as appropriate.
- Returns:
The value of object_id.
- Return type:
object_id (any)
- property object_id_as_string¶
Gets object_id_as_string.
- Summary:
Gets the object as a string.
- Remarks:
The string returned contains details of the referenced object and may include the objects name and version as appropriate.
- Returns:
The value of object_id_as_string.
- Return type:
object_id_as_string (str)
- property relationship¶
Gets Relationship.
- Summary:
The type of relationship.
- Returns:
The value of Relationship.
- Return type:
- property relationship_as_string¶
Gets relationship_as_string.
- Summary:
The relationship type as a string.
- Returns:
The value of relationship_as_string.
- Return type:
relationship_as_string (str)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
Examples