IDocumentRowsetOptions¶
- class IDocumentRowsetOptions¶
Bases:
ImpactCOMWrapperBase- Summary:
An object that allows document “rowsets” to be fetched (using the find_rowset method).
- Remarks:
A rowset is a string that contains XML data, structured into row and column elements. Introduced in Impact 10.0.0.44.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property include_deleted¶
Gets include_deleted.
- Summary:
Specifies if documents marked as deleted will be included in the rowset.
- Returns:
The value of include_deleted.
- Return type:
include_deleted (bool)
- property include_purged¶
Gets include_purged.
- Summary:
Specifies if documents marked as purged will be included in the rowset.
- Returns:
The value of include_purged.
- Return type:
include_purged (bool)
- property rowset_options¶
Gets rowset_options.
- Summary:
An IRowsetOptions object defining the rowset options
- Returns:
The value of rowset_options.
- Return type:
- add_relationship(type, object_id, external_type)¶
- Summary:
Adds a relationship to a specific object type allowing links to one or more objects of that type.
- Parameters:
type (ipDocumentRelationship) – Type of object
object_id (any) – Object Id
external_type (str) – External type
- count_total_rows()¶
- Summary:
Count total rows
- Remarks:
Introduced in Impact 10.0.0.67
- find_rowset()¶
- Summary:
Find a “rowset” (XML representation of row and column data) based on the specified options.
- Returns:
A string that contains XML data, structured into row and column elements.
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.