IDatabaseQueryMasterSettingCriterion¶
- class IDatabaseQueryMasterSettingCriterion¶
Bases:
ImpactCOMWrapperBase- Summary:
A single criterion for a database query (IDatabaseQueryMasterSetting).
- Remarks:
Introduced in Impact 5.1.4.24
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property has_user_value¶
Gets has_user_value.
- Summary:
Flag that indicates if this criterion accepts user input.
- Returns:
The value of has_user_value.
- Return type:
has_user_value (bool)
- property is_between¶
Gets is_between.
- Summary:
Flag that indicates if this criterion accepts a range of values.
- Returns:
The value of is_between.
- Return type:
is_between (bool)
- property prompt¶
Gets Prompt.
- Summary:
Text that describes the criterion.
- Remarks:
Eg “Reference contains”
- Returns:
The value of Prompt.
- Return type:
prompt (str)
- property type¶
Gets Type.
- Summary:
The data type of the database column associated with this criterion.
- Returns:
The value of Type.
- Return type:
- property user_value_can_be_null¶
Gets user_value_can_be_null.
- Summary:
Flag that indicates if this criterion accepts a NULL value from the user input.
- Remarks:
Only applies if has_user_value is true.
- Returns:
The value of user_value_can_be_null.
- Return type:
user_value_can_be_null (bool)
- property value¶
Gets Value.
- Summary:
Gets and sets the value for this criterion.
- Remarks:
Only applies if is_between is false. Range values must be accessed through get_range & set_range.
- Returns:
The value of Value.
- Return type:
value (any)
- get_range()¶
- Summary:
Gets the range of values for this criterion.
- Remarks:
Only applies if is_between is true.
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
- set_range(lo_val, hi_val)¶
- Summary:
Sets the range of values for this criterion.
- Remarks:
Only applies if is_between is true.
- Parameters:
lo_val (any) – The minimum range value.
hi_val (any) – The maximum range value.