Difference between revisions of "QUERYITEM"

Query Item
Name	QUERYITEM
Namespace	System.Query
Internal Name	SystemObjects.QUERYITEM
TypeString	UBIK.Kernel.MetaClass
RuntimeType	UBIK.Kernel.QueryItem
Purpose	Configure query items
Version	2+

Latest revision as of 16:59, 3 December 2019

A QueryItem defines a single filter rule for the evaluation of the result collection of a Query. This filter rule has the following parameters:

Parameter	DataType	Example(s)	Comment
NAME	Text	Any	The name of the MetaProperty the filter value should be compared for.
OPERATOR	Text	=, <=, <, >, >=, !=	The comparison operator. The value must correspond to an item of the QuerySearchItemOperator enumeration.
LIKECOMPARISON	Boolean	true / false	If true, the given item is applied as LIKE filter criteria where a wildcard is automatically added to the end of the filter value; for an additional wildcard at the beginning of the filter value add % - if true, this overrides the OPERATOR configuration.
FILTERVALUE	Text	Any	This filter value is compared to the property values (for the specified MetaProperty) of the objects to find, using the operator. If the comparison result is True, there is a positive match.
INDEX	Integer	Any	Specifies the index of the property value to compare. Use -1 for the standard value.
ISNULL	Boolean	true / false	True, if the query item should match for NULL values; if true, this overrides the LIKECOMPARISON and OPERATOR configuration.
LOGICALAND	Boolean	true / false	If true, the given QueryItem and its predecessor are logically joined using AND; otherwise using OR

@@ Line 17: / Line 17: @@
 ! style="width:150px" | Parameter !! DataType !! Example(s) !! Comment
 |-
-| NAME || {{Text}} || Any || Name of MetaProperty the filter values should be searched in
+| NAME || {{Text}} || Any || The name of the MetaProperty the filter value should be compared for.
 |-
-| OPERATOR || {{Text}} || =,<,>,>=,... || value must correspond to an item of the QuerySearchItemOperator enumeration
+| OPERATOR || {{Text}} || =, <=, <, >, >=, != || The comparison operator. The value must correspond to an item of the QuerySearchItemOperator enumeration.
 |-
-| LIKECOMPARISON|| {{Boolean}} || true / false || if true, the given item is applied as '''LIKE''' filter criteria where a wildcard is automatically added to the end of the filtervalue; for an additional wildcard at the beginning of the filter value add '''%'''
+| LIKECOMPARISON|| {{Boolean}} || true / false || If true, the given item is applied as '''LIKE''' filter criteria where a wildcard is automatically added to the end of the filter value; for an additional wildcard at the beginning of the filter value add '''%''' - if true, this overrides the OPERATOR configuration.
 |-
-| FILTERVALUE|| {{Text}} || Any || the value the objects are compared to
+| FILTERVALUE|| {{Text}} || Any || This filter value is compared to the property values (for the specified MetaProperty) of the objects to find, using the operator. If the comparison result is True, there is a positive match.
 |-
-| INDEX || {{Integer}} || Any || property has index values and filtering should consider a certain index
+| INDEX || {{Integer}} || Any || Specifies the index of the property value to compare. Use '''-1''' for the standard value.
 |-
-| ISNULL|| {{Boolean}} || true / false|| searched for NULL values
+| ISNULL|| {{Boolean}} || true / false|| True, if the query item should match for NULL values; if true, this overrides the LIKECOMPARISON and OPERATOR configuration.
 |-
-| LOGICALAND || {{Boolean}} || true / false || if true, the given QueryItem and its predecessor are logically joined using '''AND'''; otherwise using '''OR'''
+| LOGICALAND || {{Boolean}} || true / false || If true, the given QueryItem and its predecessor are logically joined using '''AND'''; otherwise using '''OR'''
 |}
 == See also ==
 * [[QUERY]]