IDocumentRelationship¶
- class IDocumentRelationship¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a document relationship between the document and another object.
- 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 created_by¶
Gets created_by.
- Description:
An IUser object representing the user that created the relationship.
- Returns:
The value of created_by.
- Return type:
- property created_date_time¶
Gets created_date_time.
- Description:
The datetime the relationship was created.
- Returns:
The value of created_date_time.
- Return type:
created_date_time (datetime)
- property document¶
Gets Document.
- Description:
The document this relationship is associated with.
- Remarks:
When document_latest_version is true the Document property returns the latest document version in the document series. When document_latest_version is false the Document property returns the specific document version this relationship was created for.
- property document_latest_version¶
Gets document_latest_version.
- Description:
Determines if the relationship is to the latest document version in a document series.
- Remarks:
When document_latest_version is true the relationship is always to the latest document version in a document series. When document_latest_version is false the relationship is to a specific document version.
- Returns:
The value of document_latest_version.
- Return type:
document_latest_version (bool)
- property external_type¶
Gets external_type.
- Description:
A unique identifier for the type of external object being referenced.
- Returns:
The value of external_type.
- Return type:
external_type (str)
- property object_id¶
Gets object_id.
- Description:
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 will be 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.
- Description:
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.
- Description:
The type of relationship.
- Returns:
The value of Relationship.
- Return type:
- property relationship_as_string¶
Gets relationship_as_string.
- Description:
The relationship type as a string.
- Returns:
The value of relationship_as_string.
- Return type:
relationship_as_string (str)
- property version¶
Gets Version.
- Description:
A version for the object_id of the relationship.
- Remarks:
This property is optional and typically only used when the Relationship is drExternal.
- Returns:
The value of Version.
- Return type:
version (str)
- delete()¶
- Description:
Permanently deletes the document relationship.