Query Object Parameters
The following tables provide descriptions of the option, condition, and value parameters for a query object.
Parameter |
Description |
Values |
---|---|---|
autoFind |
Directs the query to automatically press Find on the form to populate the grid records. You do not need to include events to press the Find button if you use autoFind. |
true, false |
matchType |
Determines if you want the query to search for records that match all (AND) or any (OR) of the specified conditions. |
MATCH_ALL, MATCH_ANY |
autoClear |
Determines if you want to clear all other fields on the form (for example default filter fields). |
true, false |
Parameter |
Description |
Value |
---|---|---|
controlId |
The control ID that the condition applies to. This is the field that you add to the query from the form when using the web client to create a Query. It is either a filter field or a grid column that is associated with the business view. |
Example of control IDs: "28", "1[34]" |
operator |
The comparison operation to use with the query. |
For all types, valid values are: BETWEEN, LIST, EQUAL, NOT_EQUAL, LESS, LESS_EQUAL, GREATER, GREATER_EQUAL For strings, valid values are: STR_START_WITH, STR_END_WITH, STR_CONTAIN, STR_BLANK, STR_NOT_BLANK |
Parameter |
Description |
Value |
---|---|---|
content |
This is either a literal value to be used in the comparison operation, or it relates to a special value ID. |
Examples of values are: "23", "Joe", "2" |
specialValueId |
This is a special value, mostly for dates that might be the current day (TODAY), or calculated dates from the current day. For calculated dates, the content field is used in the calculation. |
Valid values are: LITERAL, TODAY, TODAY_PLUS_DAY, TODAY_MINUS_DAY, TODAY_PLUS_MONTH, TODAY_MINUS_MONTH, TODAY_PLUS_YEAR, TODAY_MINUS_YEAR |