Skip to main content


class %DeepSee.Model.KPI.filter extends %DeepSee.Model.KPI.node

Meta-data for a filter within a DeepSee KPI.

Property Inventory

Method Inventory


property defaultValue as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Default value to apply to this filter.
Property methods: defaultValueDisplayToLogical(), defaultValueGet(), defaultValueIsValid(), defaultValueLogicalToDisplay(), defaultValueLogicalToOdbc(), defaultValueNormalize(), defaultValueSet()
property dependsOn as %String (XMLPROJECTION = "attribute");
Optional. If defined, this is the logical name of the controlling filter on which this filter depends. In this case, the set of possible values for this filter will depend on the current value of the controlling filter.
Property methods: dependsOnDisplayToLogical(), dependsOnGet(), dependsOnIsValid(), dependsOnLogicalToDisplay(), dependsOnLogicalToOdbc(), dependsOnNormalize(), dependsOnSet()
property displayList as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Optional. List of possible display values for this filter.
Property methods: displayListDisplayToLogical(), displayListGet(), displayListIsValid(), displayListLogicalToDisplay(), displayListLogicalToOdbc(), displayListNormalize(), displayListSet()
property filterProperty as %String (MAXLEN = 100, XMLPROJECTION = "attribute");
Logical name of the property controlled by this filter.
Property methods: filterPropertyDisplayToLogical(), filterPropertyGet(), filterPropertyIsValid(), filterPropertyLogicalToDisplay(), filterPropertyLogicalToOdbc(), filterPropertyNormalize(), filterPropertySet()
relationship kpi as %DeepSee.Model.KPI.kpi (XMLPROJECTION = "none") [ Inverse = filters , Cardinality = one ];
KPI that this property belongs to.
Property methods: kpiGet(), kpiGetObject(), kpiGetObjectId(), kpiGetSwizzled(), kpiIsValid(), kpiNewObject(), kpiRClose(), kpiRExec(), kpiRFetch(), kpiRelate(), kpiSQLCompute(), kpiSet(), kpiUnRelate()
property multiSelect as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Optional. If true (the default) let the user select multiple values for this filter.
Property methods: multiSelectDisplayToLogical(), multiSelectGet(), multiSelectIsValid(), multiSelectLogicalToDisplay(), multiSelectLogicalToXSD(), multiSelectNormalize(), multiSelectSet(), multiSelectXSDToLogical()
property searchType as %String (VALUELIST = ",day", XMLPROJECTION = "attribute");
Optional. If defined, this specified how this filter should be display by the DeepSee searchBox control.
Property methods: searchTypeDisplayToLogical(), searchTypeGet(), searchTypeIsValid(), searchTypeLogicalToDisplay(), searchTypeLogicalToOdbc(), searchTypeNormalize(), searchTypeSet()
property sql as %String (MAXLEN = 2000, XMLPROJECTION = "attribute");
Optional. SQL query executed to get list of possible values for this filter. The first query column provides the value for the filter member. The second query column provides the display name for the filter member. If there is only one column, it is provides both value and display name. This is ignored if valueList is defined.
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()
property valueList as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
Optional. List of possible values for this filter.
Property methods: valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet()


method %Validate() as %Status
Test if this filter's definition is valid.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab