IRowsetOptions¶
- class IRowsetOptions¶
Bases:
ImpactCOMWrapperBase- Summary:
Options used to determine which rowsets are returned (for example from IDatabase.find_rowset).
- Remarks:
Introduced in Impact 9.0.0.42.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property column_names¶
Gets column_names.
- Summary:
Column names
- Returns:
The value of column_names.
- Return type:
column_names (str)
- property find_items_options¶
Gets find_items_options.
- Summary:
An IFindItemsOptions object defining the search criteria
- Returns:
The value of find_items_options.
- Return type:
- property inactive_row_context¶
Gets inactive_row_context.
- Summary:
Determines whether to find active and/or inactive items.
- Remarks:
Introduced in Impact 11.0.0.80
- Returns:
The value of inactive_row_context.
- Return type:
- property primary_table_name¶
Gets primary_table_name.
- Summary:
Name of primary table.
- Returns:
The value of primary_table_name.
- Return type:
primary_table_name (str)
- property range_query_error_code¶
Gets range_query_error_code.
- Summary:
Indicates whether or not the ranged query was successfully executed.
- Returns:
The value of range_query_error_code.
- Return type:
- property row_offset¶
Gets row_offset.
- Summary:
Specifies whether or not a ranged query will be attempted.
- Remarks:
A row_offset greater than or equal to zero specifies that a ranged query will be attempted. The default value is -1, and left like that, the find methods will return at most max_records. However, for row_offset greater than or equal to zero, the query will be ranged, with a “page” size of max_records, where row_offset specifies the position of the first row to include in the page.
- Returns:
The value of row_offset.
- Return type:
row_offset (int)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
- use_relationship_lookup(value)¶
- Summary:
Use the specified database table relationship.
- Remarks:
Introduced in Impact 11.0.0.31
- Parameters:
value (str) – A string representing the database table relationship.