Description
The QueryLimit class holds the base data for each query limit.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
from |
int |
1..1 |
The index of the first field to return |
loadChildren |
boolean |
1..1 |
Indicates if the server need to send the any linked children, default is true |
maxRecords |
int |
1..1 |
The maximum number of records to return |
orderBy |
0..* |
The fields to sort by (including the sort order) |
|
to |
int |
1..1 |
The index of the last field to return |
Remarks
A query limit is a set of bounds for a search, plus a list of fields to order the search by. The from and to indices represent the bounds for the search, and the limit represents the maximum number of records to be returned. Note that the system itself may introduce additional limits on the number of records returned by each call. Therefore, an exhaustive list call should loop until no more records are returned.
The orderBy parameter is an on array of zero or more orderedField elements, each being a name of a field to sort by (the field names being the member variable names within the relevant complex type), plus a sort order. For more details on orderedField, see the orderedField complex type.