QueryFilter Property
Selects only the entries that satisfy the specified filter (expression).
Syntax
odata.getQueryFilter([callback]) odata.setQueryFilter( queryFilter, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getQueryFilter([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setQueryFilter([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.
Below are the operators supported in the expression language.
Logical Operators
| Operator | Description | Example |
| eq | Equal | "City eq 'Durham'" |
| ne | Not Equal | "City ne 'North Carolina'" |
| gt | Greater Than | "Price gt 20" |
| ge | Greater Than or Equal | "Price ge 10" |
| lt | Less Than | "Price lt 20" |
| le | Less Than Or Equal | "Price le 100" |
| and | Logical And | "Price le 200 and Price gt 3.5 " |
| or | Logical Or | "Price le 3.5 or Price gt 200" |
| not | Logical Not | "not endswith(Description,'milk')" |
Arithmetic Operators
| Operator | Description | Example |
| add | Addition | "Price add 5 gt 10" |
| sub | Subtraction | "Price sub 5 gt 10" |
| mul | Multiplication | "Price mul 2 gt 2000" |
| div | Division | "Price div 2 gt 4" |
| mod | Modulo | "Price mod 2 eq 0" |
Grouping Operators
| Operator | Description | Example |
| ( ) | Precedence Grouping | "(Price sub 5) gt 10 " |
Below are the functions supported in the expression language.
String Functions
| Function | Example |
| bool substringof(string po, string p1) | "substringof('Alfreds', CompanyName) eq true" |
| bool endswith(string p0, string p1) | "endswith(CompanyName, 'Futterkiste') eq true" |
| bool startswith(string p0, string p1) | "startswith(CompanyName, 'Alfr') eq true" |
| int length(string p0) | "length(CompanyName) eq 19" |
| int indexof(string p0, string p1) | "indexof(CompanyName, 'lfreds') eq 1" |
| string replace(string p0, string find, string replace) | "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'" |
| string substring(string p0, int pos) | "substring(CompanyName, 1) eq 'lfreds Futterkiste'" |
| string substring(string p0, int pos, int length) | "substring(CompanyName, 1, 2) eq 'lf'" |
| string tolower(string p0) | "tolower(CompanyName) eq 'alfreds futterkiste'" |
| string toupper(string p0) | "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'" |
| string trim(string p0) | "trim(CompanyName) eq 'Alfreds Futterkiste'" |
| string concat(string p0, string p1) | "concat(concat(City, ', '), Country) eq 'Berlin, Germany'" |
Date Functions
| Function | Example |
| int day(DateTime p0) | "day(BirthDate) eq 8" |
| int hour(DateTime p0) | "hour(BirthDate) eq 0" |
| int minute(DateTime p0) | "minute(BirthDate) eq 0" |
| int month(DateTime p0) | "month(BirthDate) eq 12" |
| int second(DateTime p0) | "second(BirthDate) eq 0" |
| int year(DateTime p0) | "year(BirthDate) eq 1948" |
Math Functions
| Function | Example |
| double round(double p0) | "round(Freight) eq 32" |
| decimal round(decimal p0) | "round(Freight) eq 32" |
| double floor(double p0) | "round(Freight) eq 32" |
| decimal floor(decimal p0) | "floor(Freight) eq 32" |
| double ceiling(double p0) | "ceiling(Freight) eq 33" |
| decimal ceiling(decimal p0) | "floor(Freight) eq 33" |
Type Functions
| Function | Example |
| bool IsOf(type p0) | "isof('NorthwindModel.Order')" |
| bool IsOf(expression p0, type p1) | "isof(ShipCountry, 'Edm.String')" |
This property is not available at design time.
Data Type
String