Named Query Technical Reference
Summary
- Named Queries are stored in NamedQuery section of Initial Adaptable State
Named Query State
The NamedQuery section of Initial Adaptable State contains just a single collection:
| Property | Description |
|---|---|
| NamedQueries | Named Queries which can be referenced in other Expressions |
Named Query
A Named Query has a single string property called Name:
| Property | Description |
|---|---|
| Name | Name of the Query, used to reference it in AdaptableQL Expressions |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
It inherits from AdaptableBooleanQuery which also has a single property:
| Property | Description |
|---|---|
| BooleanExpression | AdapTableQL Expression that returns true / false |
Named Query API
| Method | Description |
|---|---|
| addNamedQueries(namedQueries) | Adds multiple new Named Query to Adaptable State |
| addNamedQuery(namedQueries) | Adds a new Named Query to Adaptable State |
| getNamedQueries() | Gets all Named Queries in Adaptable State |
| getNamedQueryByName(namedQueryName) | Retrieves Named Query with given name from State |
| getNamedQueryState() | Retrieves Query section from Adaptable State |
| isValidNamedQuery(namedQuery) | Checks if the given Named Query has a valid name |
| openNamedQuerySettingsPanel() | Opens Settings Panel with Query section selected and visible |
| runNamedQuery(namedQuery) | Runs the given Named Query |
| runQueryByName(queryName) | Runs Named Query which has given name |