Difference between revisions of "QUERYSCOPE"
m (Text replacement - "{{UBIKCLIENT}}" to "{{UBIK Client}}") |
(→Configuration) |
||
| Line 20: | Line 20: | ||
* evaluates the query using an equal (=) operator if no query item exist | * evaluates the query using an equal (=) operator if no query item exist | ||
| − | [[Category:Context scope]] | + | === PropertyValues for the QueryInstance === |
| − | [[Category:Metaclasses]] | + | As described above, every [[MetaProperty|MetaProperties]] defined in the [[ACM]] will serve as filter criteria on the client. In some cases it might be necessary that you need to send data for the Query itself (e.g. an Icon, Statuscosor or MANUAL_EVALUATION_ONLY). As these properties should not be interpreted as filtercriteria you need to tell the QueryScope to use them like normal properties. For this you have to override the TakePropertyValueFromQueryInstance method on the Query Scope. |
| + | |||
| + | Example: | ||
| + | |||
| + | protected override bool TakePropertyValueFromQueryInstance(MetaProperty mp) | ||
| + | { | ||
| + | if (mp.Name == "MANUAL_EVALUATION_ONLY") | ||
| + | { | ||
| + | return true; | ||
| + | } | ||
| + | return base.TakePropertyValueFromQueryInstance(mp); | ||
| + | } | ||
| + | |||
| + | [[Category:Context scope|QUERYSCOPE]] | ||
| + | [[Category:Metaclasses|QUERYSCOPE]] | ||
Revision as of 11:22, 11 September 2025
 Query Scope |
|
|---|---|
| Name | QUERYSCOPE |
| Namespace | System.ACM.Scopes |
| Internal Name | SystemObjects.QUERYSCOPE |
| TypeString | UBIK.Kernel.MetaClass |
| RuntimeType | UBIK.Content.ACM.QueryScope |
| Purpose | Configure content queries |
| Version | 2.1.13+ |
A QueryScope defines how a Query and its results are visualized on the UBIK® Client and is accessed from the Content Browser acting as a search mechanism.
Configuration
The configuration of the query has to be done completely on the server side, where the published MetaProperties defined in the ACM serve as filter criteria on the client. If a Query is executed on the client the system verifies for each of the filter criteria if the Query possesses a suitable QueryItem and
- evaluates the query based on the configuration of the query item using the specified operator, etc. if a query item exist
- evaluates the query using an equal (=) operator if no query item exist
PropertyValues for the QueryInstance
As described above, every MetaProperties defined in the ACM will serve as filter criteria on the client. In some cases it might be necessary that you need to send data for the Query itself (e.g. an Icon, Statuscosor or MANUAL_EVALUATION_ONLY). As these properties should not be interpreted as filtercriteria you need to tell the QueryScope to use them like normal properties. For this you have to override the TakePropertyValueFromQueryInstance method on the Query Scope.
Example:
protected override bool TakePropertyValueFromQueryInstance(MetaProperty mp) {
if (mp.Name == "MANUAL_EVALUATION_ONLY")
{
return true;
}
return base.TakePropertyValueFromQueryInstance(mp);
}
