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
| Property | Summary |
|---|---|
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| title | Title of additional field. |
| isFilterable | Boolean flag for indicating, if this field is filterable |
| contentType | ContentType of additional field. |
| useConsumer | Boolean flag for indicating, if this filter extension should use a consumer to select a value (instead of the filterValuesProcess) |
| consumer | Specify already existent consumers within this entity to define possibleValues for this filter extension. A lookup-component will be available in the client to… |
| filterValuesProcess | This process delivers possible values for this field. |
| filterConditionProcess | This process delivers a condition, which will be used to obtain the recordset |
| groupedRecordField | Recordfield which will be used for grouping |
| titleRecordField | Recordfield, which contains the title of a group |
| isGroupable | 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… |
| groupQueryProcess | 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. |
| filtertype | Delivers a hint, to which filter this field(s) should be added |
| isLookupFilter | Delivers a hint, if this filter is a lookup to an other context |
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 he designed.
You may want to add the plugin "AsciidoctorJ" to your ADITO Designer in order
to modify AsciiDoc files.
title
Type: String
Title of additional field.
isFilterable
Type: Boolean
Default: true
Boolean flag for indicating, if this field is filterable
contentType
Type: EContentType
ContentType of additional field.
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)
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.
filterValuesProcess
Type: String
Requires: useConsumer property group
This process delivers possible values for this field.
Parameters
$local.filter
A JSON object with fields, operator and value
filterConditionProcess
Type: String
This process delivers a condition, which will be used to obtain the recordset
groupedRecordField
Type: String
Recordfield which will be used for grouping
titleRecordField
Type: String
Recordfield, which contains the title of a group
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.
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"
filtertype
Type: EFilterType
Delivers a hint, to which filter this field(s) should be added
isLookupFilter
Type: Boolean
Delivers a hint, if this filter is a lookup to an other context