IDocumentCreatorRelationship¶
- class IDocumentCreatorRelationship¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a document relationship used with the IDocumentCreator.
- Remarks:
The IDocumentCreator.perform method uses the properties of the IDocumentCreatorRelationship to create document relationships for each document created or add new relationships to existing documents. 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 document_latest_version¶
Gets document_latest_version.
- Description:
Links the relationship to the latest document version when true, or the current document version when false.
- Returns:
The value of document_latest_version.
- Return type:
document_latest_version (bool)
- property external_type¶
Gets external_type.
- Description:
The external type of relationship for drExternal.
- Returns:
The value of external_type.
- Return type:
external_type (str)
- property object_id¶
Gets object_id.
- Description:
The object that this relationship references.
- 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 to add.
- 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)