Last modified on 11 September 2025, at 11:26

Difference between revisions of "QUERYSCOPE"

m (moved Query Scope to QueryScope)
(→‎PropertyValues for the QueryInstance)
 
(19 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
| title = Query Scope
 
| title = Query Scope
 
| name = QUERYSCOPE
 
| name = QUERYSCOPE
−
| internalname = QueryScope
+
| internalname = SystemObjects.{{PAGENAME}}
−
| namespace = System.Query
+
| namespace = System.ACM.Scopes
 
| image = [[File:SY_QUERYSCOPE.png|220px]]
 
| image = [[File:SY_QUERYSCOPE.png|220px]]
 
| imagecaption = Query Scope
 
| imagecaption = Query Scope
 
| purpose = Configure content queries
 
| purpose = Configure content queries
−
| context = MetaClass
 
 
| version = 2.1.13+
 
| version = 2.1.13+
 +
| typestring = UBIK.Kernel.MetaClass
 +
| runtimetype = UBIK.Content.ACM.QueryScope
 
}}
 
}}
 +
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.
  
−
The Query Scope is used to define the behaviour of a query instance on the mobile side. MetaProperties can be defined which servce as filter criteria on the client.
+
== Configuration ==
 +
[[File:UI_QueryScope_04.PNG|thumb|border|220px|alt=Published MetaProperties as Filter Criteria|Published MetaProperties as Filter Criteria]]
 +
The configuration of the query has to be done completely on the server side, where the published [[MetaProperty|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
  
−
[[Category:UBIK System MetaClasses]]
+
=== PropertyValues for the QueryInstance ===
−
[[Category:UBIK Context Scopes]]
+
As described above, every [[MetaProperty|MetaProperties]] defined in the [[ACM]] will serve as filter criterion on the client. In some cases it might be necessary that you need to send data for the Query itself (e.g. an Icon, StatusColor or MANUAL_EVALUATION_ONLY). As these properties should not be interpreted as filtercriterion 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]]

Latest revision as of 11:26, 11 September 2025

IC METACLASS.gif 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

Published MetaProperties as Filter Criteria
Published MetaProperties as Filter Criteria

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 criterion on the client. In some cases it might be necessary that you need to send data for the Query itself (e.g. an Icon, StatusColor or MANUAL_EVALUATION_ONLY). As these properties should not be interpreted as filtercriterion 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);

}