IProjectAndLayerFilterOptions¶
- class IProjectAndLayerFilterOptions¶
Bases:
ImpactCOMWrapperBase- Description:
A parameters object used to establish project and layer filtering that will be applied to all project and layer searches for this Impact (or nServer) session.
- Remarks:
Introduced in Impact 6.2.0.6 Call IDatabase.project_and_layer_filter_options with this object to establish the filtering. The filtering will be cleared on reconnecting to the database.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property customer_keys¶
Gets customer_keys.
- Description:
A list of customer keys by which to filter projects.
- Remarks:
Only projects assigned to the listed customers will be included. However, if customer_keys is NULL, projects assigned to any customer will be included.
- Returns:
The value of customer_keys.
- Return type:
customer_keys (any)
- property explicitly_exclude_null_status¶
Gets explicitly_exclude_null_status.
- Description:
Flag indicating if items having a NULL status value should be excluded.
- Remarks:
Introduced in Impact 7.0.0.25 This property has now been deprecated (since Impact 11.0.0.73) because the same information can be gleaned more obviously from null_status_equivalent.
- Returns:
The value of explicitly_exclude_null_status.
- Return type:
- property include_added_layers¶
Gets include_added_layers.
- Description:
Specifies if added layers will be included when searching for layers.
- Returns:
The value of include_added_layers.
- Return type:
include_added_layers (bool)
- property include_deleted_layers¶
Gets include_deleted_layers.
- Description:
Specifies if deleted layers will be included when searching for layers.
- Returns:
The value of include_deleted_layers.
- Return type:
include_deleted_layers (bool)
- property include_null_status¶
Gets include_null_status.
- Description:
Flag indicating if items having a NULL status value should be included.
- Remarks:
This property has now been deprecated (since Impact 11.0.0.73) because the same information can be gleaned more obviously from null_status_equivalent.
- Returns:
The value of include_null_status.
- Return type:
include_null_status (bool)
- property layer_column_name¶
Gets layer_column_name.
- Description:
Name of the status column in the LAYERS table.
- Returns:
The value of layer_column_name.
- Return type:
layer_column_name (str)
- property layer_type_mappings¶
Gets layer_type_mappings.
- Description:
This is a list of strings that map concrete layer type names to aliases that can be used by the COM consumer. The ‘:’ character is used to delimit the parts in each mapping. Eg: “ENGRAVE:Engraving” “MULTI_UP:Multo_upo” “ONE_UP:Uno_upo” This allows the alias values to be returned in rowsets (eg LAYERS.L_EXTRA) and for sorting and filter conditions on that column to respect the aliases.
- Remarks:
Introduced in Impact 13.0.0.46
- Returns:
The value of layer_type_mappings.
- Return type:
layer_type_mappings (any)
- property layer_types¶
Gets layer_types.
- Description:
A list of layer type names by which to filter.
- Remarks:
Only layers of the listed types will be included. However, if layer_types is NULL, layers of any type will be included.
- Returns:
The value of layer_types.
- Return type:
layer_types (any)
- property null_status_equivalent¶
Gets null_status_equivalent.
- Description:
Maps NULL to a specific status value.
- Returns:
The value of null_status_equivalent.
- Return type:
null_status_equivalent (int)
- Examples:
- property project_column_name¶
Gets project_column_name.
- Description:
Name of the status column in the DRAWINGS table.
- Returns:
The value of project_column_name.
- Return type:
project_column_name (str)
- property status_keys¶
Gets status_keys.
- Description:
A list of status key values by which to filter.
- Remarks:
Only items having these status values will be included. However, if status_keys is NULL, items of any status will be included.
- Returns:
The value of status_keys.
- Return type:
status_keys (any)