Skip to main content
Version: 2026.1

FilterExtension

This page provides generated reference documentation for the FilterExtension data model.

FilterExtension is an ADITO model used for extending the standard filter by an additional filter option.

Overview​

PropertySummary
consumerSpecify already existent consumers within this entity to define possibleValues for this filter extension. A lookup-component will be available in the client to…
contentTypeContentType of additional field.
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
filterConditionProcessThis process delivers a condition, which will be used to obtain the recordset
filtertypeDelivers a hint, to which filter this field(s) should be added
filterValuesProcessThis process delivers possible values for this field.
groupedRecordFieldRecordfield which will be used for grouping
groupQueryProcessThis process has to return a SQL query as string for obtaining the list of groups. Various $local variables are available to make this easier.
isFilterableBoolean flag for indicating, if this field is filterable
isGroupableIf the groupable property of a field is set, this field can be selected as a grouping in the filter, but only if the RecordContainer is pageable. This is…
isLookupFilterDelivers a hint, if this filter is a lookup to an other context
titleTitle of additional field.
titleRecordFieldRecordfield, which contains the title of a group
useConsumerBoolean flag for indicating, if this filter extension should use a consumer to select a value (instead of the filterValuesProcess)

consumer​

Type: String
Requires: useConsumer property group

Specify already existent consumers within this entity to define possibleValues for this filter extension. A lookup-component will be available in the client to select a record.

<!--EOF-->

This element is only used if useConsumer is set to true.

contentType​

Type: EContentType

ContentType of additional field.

documentation​

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

filterConditionProcess​

Type: String

This process delivers a condition, which will be used to obtain the recordset

filtertype​

Type: EFilterType

Delivers a hint, to which filter this field(s) should be added

filterValuesProcess​

Type: String
Requires: useConsumer property group

This process delivers possible values for this field.

<!--EOF-->

This element is only used if useConsumer is set to false.

Parameters​

$local.filter
  A JSON object with fields, operator and value

groupedRecordField​

Type: String

Recordfield which will be used for grouping

groupQueryProcess​

Type: String

This process has to return a SQL query as string for obtaining the list of groups. Various $local variables are available to make this easier.

  • $local.name: Contains the full name in the following format: entityName.fieldName
  • $local.fieldname: Contains the fieldName
  • $local.contenttype: Contains the type of the field, e.g. TEXT, NUMBER, IMAGE, BOOLEAN, ...
  • $local.columntype: Contains the generic SQL type, e.g. VARCHAR, NUMERIC, BINARY, TIMESTAMP, ...
  • $local.count: Contains a boolean which is true, if only the number of records is required. If this property is true the data can be ignored. Only the number of records must be correct.
  • $local.columns: Contains the columns of a table which are required as string array.
  • $local.columnlist: Contains the columns of a table which are required in a comma separated list. Can never be null, only empty list.
  • $local.condition: Contains the where-clause of an SQL as string.
  • $local.grouped: Contains the current grouping in form of an array.
  • $local.groupedList: Contains the current grouping as comma separated list.
  • $local.order: Contains the fields and the corresponding order as a map in the following format: e.g. ATTRIBUTE_TYPE.displayValue -> UP

isFilterable​

Type: Boolean
Default: true

Boolean flag for indicating, if this field is filterable

isGroupable​

Type: Boolean

If the groupable property of a field is set, this field can be selected as a grouping in the filter, but only if the RecordContainer is pageable. This is only possible in views that support grouping - for example: Tree, TreeTable, Chart, Map.

isLookupFilter​

Type: Boolean

Delivers a hint, if this filter is a lookup to an other context

title​

Type: String

Title of additional field.

titleRecordField​

Type: String

Recordfield, which contains the title of a group

useConsumer​

Type: Boolean
Default: false

Boolean flag for indicating, if this filter extension should use a consumer to select a value (instead of the filterValuesProcess)