Interface: QueryHandle

QueryHandle

A query handle allows interaction with a query.

Methods

execute(options)

Executes the query.
Parameters:
Name Type Description
options Object Configuration object.
Properties
Name Type Description
options Object Holds query specific configurations.
Properties
Name Type Description
nested Boolean If true, the query will include related objects in its result set.
count Number Number of objects to return in the result.
onSuccess function Success callback if the query execution was successful.
onError function Error callback if the query execution resulted in an error.

getResult() → {Object}

Returns the result of the query.
Returns:
- The query's result set.
Type
Object

refresh()

Refrehes the query.

removeParameter(param)

Clears the value of specified parameter.
Parameters:
Name Type Description
param String The name of the parameter to clear.

setParameter(param, value, noupdate)

Sets a query parameter to the specified value.
Parameters:
Name Type Description
param String The name of the parameter.
value Object The desired value.
noupdate Boolean If true, the query will not automatically update after the value has been set.

setParameters(key-value, noupdate)

Sets a collection of parameters to their specified values.
Parameters:
Name Type Description
key-value Object pairs.
noupdate Boolean If true, the query will not automatically update after the value has been set.

setQueryParameters(qps)

Sets query parameter values according to the specified map.
Parameters:
Name Type Description
qps Object Map of query parameter name and value pairs.