ILookupParameters¶

class ILookupParameters¶

Bases: ImpactCOMWrapperBase

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property display_column¶

Gets display_column.

property filter_sql¶

Gets filter_sql.

property known_key¶

Gets known_key.

Summary:: Key of row that must be included.
Remarks:: There are situations where you may need include the row for a specific key, even if the filter_sql or now row’s active status would otherwise exclude it. This might be necessary to display a look-ups “current value” which may no longer be a natural part of the lookup row set. known_key promotes selection of the desired row ensuring it is always included. See also the known_key_exclusive property.

property known_key_exclusive¶

Gets known_key_exclusive.

Summary:: Indicates whether to return only the row given by the known_key value.
Remarks:: This flag supplements know_key to restrict the selection to this single row, which results in simpler and more efficient SQL.

property order_by_sql¶

Gets order_by_sql.

Summary:: Optionally specifies how the results should be sorted.
Remarks:: Note that the “order by” keywords should not be included in this string.

property relationships¶

Gets Relationships.

property respect_active_flags¶

Gets respect_active_flags.

Summary:: Indicates whether the active flag should be used to filter the rows.
Remarks:: The active/archived flag is optionally defined for the table. Sometimes you may wish to generate lookup results that include inactive/archived values.

property table_name¶

Gets table_name.

isNone()¶: Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.