IDocumentTag¶
- class IDocumentTag¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a managed document tag.
- 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 documents¶
Gets Documents.
- Description:
The documents associated with this IDocumentTag.
- Returns:
The value of Documents.
- Return type:
- property documents_count¶
Gets documents_count.
- Description:
The number of documents associated with this IDocumentTag.
- Remarks:
The documents_count property includes all documents with a status of dsNormal, dsDeleted and dsDataPurged. The documents_count property does not include private working documents associated with the document tag.
- Returns:
The value of documents_count.
- Return type:
documents_count (int)
- property documents_deleted_count¶
Gets documents_deleted_count.
- Description:
The number of deleted documents associated with this IDocumentTag.
- Remarks:
The documents_deleted_count property only includes documents with a status of dsDeleted.
- Returns:
The value of documents_deleted_count.
- Return type:
documents_deleted_count (int)
- property documents_purged_count¶
Gets documents_purged_count.
- Description:
The number of purged documents associated with this IDocumentTag.
- Remarks:
The documents_purged_count property only includes documents with a status of dsDataPurged.
- Returns:
The value of documents_purged_count.
- Return type:
documents_purged_count (int)
- property synonyms¶
Gets Synonyms.
- Description:
An array of tag values that are synonyms for this IDocumentTag.
- Remarks:
When assigning synonym tags the IDocumentTags must already exist otherwise they will be ignored. Synonyms are a two-way relationship assigning a IDocumentTag as a synonym of another IDocumentTag creates a synonym relationship between both. The synonyms_count property provides a count of currently assign synonyms. The synonyms_as_string property provides a string representation of all synonyms.
- Returns:
The value of Synonyms.
- Return type:
synonyms (any)
- property synonyms_as_string¶
Gets synonyms_as_string.
- Description:
Gets the Synonyms property as a formatted string.
- Returns:
The value of synonyms_as_string.
- Return type:
synonyms_as_string (str)
- property synonyms_count¶
Gets synonyms_count.
- Description:
The number of synonyms associated with this IDocumentTag.
- Returns:
The value of synonyms_count.
- Return type:
synonyms_count (int)
- property value¶
Gets Value.
- Description:
The tag value.
- Remarks:
You should use the is_valid_tag method to determine if the Value you are modifying is valid.
- Returns:
The value of Value.
- Return type:
value (str)
- property value_translated_xml¶
Gets value_translated_xml.
- Description:
The XML used to store translations for the Value property.
- Remarks:
This property is used internally.
- Returns:
The value of value_translated_xml.
- Return type:
value_translated_xml (str)
- delete()¶
- Description:
Permanently deletes the managed document tag.
- Remarks:
Any IDocument objects associated with the managed tag will also have their association automatically deleted. If you wish to retain these associations and assign them to another existing IDocumentTag you can use the merge_to method.
- do_update()¶
- Description:
Update the modified tag directly in the database.
- Remarks:
When modifying one or more tag properties update all the values with a single call to do_update.
- merge_to(tag)¶
- Description:
Merges this IDocumentTag with another managed tag.
- Remarks:
After merging all documents associated with this IDocumentTag will be associated with the Tag specified. After merging all document Synonyms associated with this IDocumentTag will be associated with the Tag specified.
- Parameters:
tag (IDocumentTag) – The IDocumentTag to merge this tag with.
- Examples:
- value_translated(language_id, exact_language_match)¶
- Description:
Gets the translated version of the document tag Value, in the language specified.
- Remarks:
You should check supports_translations to determine if translations are supported. For a more detailed explanation of the parameters, please see the notes for the master_setting_name_translated method.
- Parameters:
language_id (any) – A string or enum representing the language wanted.
exact_language_match (bool) – Specifies what to do if there is no translation for the specified language.