QueryOrderBy Property

The value used to order entries when querying a service.

Syntax

 odata.getQueryOrderBy([callback])
 odata.setQueryOrderBy( queryOrderBy, [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 getQueryOrderBy([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 setQueryOrderBy([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 value by which the returned entries will be order after a call to QueryService.

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending " asc" or " desc" (respectively) to your OrderBy value. For example, if you want to sort the entries by 'Rating' in descending order you would set QueryOrderBy to "Rating desc". If a specific order ('asc' or 'desc') is not specified, the entries will be returned in ascending order.

This property is not available at design time.

Data Type

String