QueryPage Arguments

The following table describes the arguments taken by the QueryPage method.

Table Arguments Taken by the QueryPage Method

Name Description Required Default I/O

ListOf(Object). For example, ListOfAccount

The list of object instances queried (input), and after query execution, the list of object instances returned (output).

Yes

Not applicable

Input/Output

pagesize

The maximum number of records displayed on a page following a query.

No

10

Input

startrownum

Indicates the row from which the QueryPage method starts to return records.

For example, if pagesize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.

No

0

Input

recordcountneeded

Indicates whether a record count for the object is to be returned.

Note: There is a performance impact if this argument is set to true. You cannot return a record count for requests in which the search specification contains calculated fields. For more information, see Using the pagesize, startrownum, and recordcountneeded Arguments.

No

false

Input

searchspec

Indicates the search specification for a field or for all the fields of an object.

No

Not applicable

Input

sortsequence

An integer value that determines the order of the sort specification.

No

Not applicable

Input

sortorder

Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.

No

ASC

Input

NamedSearchSpec

Indicates the search specification for a named list for an object.

No

Not applicable

Input

LOVLanguageMode

The language mode for picklists, see The LOVLanguageMode Argument.

No

LIC

Input

ViewMode

Specifies the level of access to records specified in the method call, see The ViewMode Argument.

Yes

Broadest

Input

BookId

The book ID.

No

Not applicable

Input

BookName

The book name. This argument is ignored if a value for BookId is supplied.

No

Not applicable

Input

IncludeSubBooks

Whether subbooks are to be included.

No

False

Input