All Classes Namespaces Files Functions Variables Groups
kerio::web::SearchQuery Struct Reference

import "SharedStructures.idl";

Public Attributes

StringList fields
 empty = give me all fields, applicable constants: ADD_USERS, LIST_USERS
SubConditionList conditions
 empty = without condition
LogicalOperator combining
 the list of conditions can be either combined by 'ORs' or 'ANDs'
long start
 how many items to skip before filling a result list (0 means skip none)
long limit
 how many items to put to a result list (if there are enough items); applicable constant: Unlimited
SortOrderList orderBy

Detailed Description

General Query for Searching

Query substitution (quicksearch):

SearchQuery doesn't support complex queries, only queries with all AND operators (or all OR operators) are supported. Combination of AND and OR is not allowed. This limitation is for special cases solved by using substitution of complicated query-part by simple condition.

Only the quicksearch is currently implemented and only in "Users::get()" method.

Behavior of quicksearch in Users::get():

QUICKSEACH = "x" is equal to: (loginName = "x") OR (fullName = "x")

QUICKSEACH LIKE "x*" is equal to: (loginName LIKE "x*") OR (fullName LIKE "x*")

QUICKSEACH <> "x" is equal to: (loginName <> "x") AND (fullName <> "x")

Member Data Documentation

LogicalOperator kerio::web::SearchQuery::combining

the list of conditions can be either combined by 'ORs' or 'ANDs'

SubConditionList kerio::web::SearchQuery::conditions

empty = without condition

StringList kerio::web::SearchQuery::fields

empty = give me all fields, applicable constants: ADD_USERS, LIST_USERS

long kerio::web::SearchQuery::limit

how many items to put to a result list (if there are enough items); applicable constant: Unlimited

long kerio::web::SearchQuery::start

how many items to skip before filling a result list (0 means skip none)


The documentation for this struct was generated from the following file: