ILookupProjectAndLayerKeysFromValueParams¶
- class ILookupProjectAndLayerKeysFromValueParams¶
Bases:
ImpactCOMWrapperBase- Summary:
A parameters object used to pass options to the IDatabase.lookup_project_and_layer_keys_from_value method.
- Remarks:
Introduced in Impact 6.1.0.26
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property column_name¶
Gets column_name.
- Summary:
The name of the column that will be searched.
- Remarks:
Will be qualified by table_name.
- Returns:
The value of column_name.
- Return type:
column_name (str)
- property current_customer_key¶
Gets current_customer_key.
- Summary:
A customer key, to filter out projects/layers not assigned to that customer.
- Remarks:
Introduced in Impact 11.0.0.49
- Returns:
The value of current_customer_key.
- Return type:
current_customer_key (int)
- property include_added_layers¶
Gets include_added_layers.
- Summary:
When searching for layers, this flag indicates whether added layers will be included.
- Returns:
The value of include_added_layers.
- Return type:
include_added_layers (bool)
- property include_deleted_layers¶
Gets include_deleted_layers.
- Summary:
When searching for layers, this flag indicates whether deleted layers will be included.
- Remarks:
Default is false.
- Returns:
The value of include_deleted_layers.
- Return type:
include_deleted_layers (bool)
- property layer_keys¶
Gets layer_keys.
- Summary:
Returns the keys of any matching layers.
- Returns:
The value of layer_keys.
- Return type:
layer_keys (any)
- property match_case¶
Gets match_case.
- Summary:
Specifies if the search will be case sensitive.
- Returns:
The value of match_case.
- Return type:
match_case (bool)
- property match_case_known¶
Gets match_case_known.
- Summary:
Leave this as false to specify that case matching should be determined internally (hence ignoring match_case)
- Remarks:
For legacy systems that don’t specify match_case, this will be false, and case matching will be determined internally.
- Returns:
The value of match_case_known.
- Return type:
match_case_known (bool)
- property matching_values¶
Gets matching_values.
- Summary:
Returns the actual values (from table_name.column_name) that match the search criterion.
- Returns:
The value of matching_values.
- Return type:
matching_values (any)
- property max_results¶
Gets max_results.
- Summary:
The maximum number of value matches to return.
- Remarks:
The result set will be capped at this value, unless it is 0, in which case, there will be no limit to the number of value matches that will be returned.
- Returns:
The value of max_results.
- Return type:
max_results (int)
- property max_results_exceeded¶
Gets max_results_exceeded.
- Summary:
Flag indicating if more than max_results value matches were found.
- Returns:
The value of max_results_exceeded.
- Return type:
max_results_exceeded (bool)
- property project_keys¶
Gets project_keys.
- Summary:
Returns the keys of any matching projects.
- Returns:
The value of project_keys.
- Return type:
project_keys (any)
- property search_type¶
Gets search_type.
- Summary:
The type of string matching to use for the search.
- Returns:
The value of search_type.
- Return type:
- property table_name¶
Gets table_name.
- Summary:
The name of the table in which column_name exists.
- Remarks:
This can be “DRAWINGS”, “LAYERS” or any of the layer type tables (“ONE_UP” etc).
- Returns:
The value of table_name.
- Return type:
table_name (str)
- property value¶
Gets Value.
- Summary:
The value to search for in the column table_name.column_name.
- Remarks:
String search, subject to search_type.
- Returns:
The value of Value.
- Return type:
value (any)
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.