Plumtree EDK (Enterprise Web Development Kit) 5.4.0 |
|
IObjectManager.QueryObjects Method (Int32, Int32, Int32, ObjectProperty, Boolean, ObjectProperty[], QueryFilter[])
Queries for objects underneath a particular folder complying to a set of filters.
Parameters
-
folderID
- the ID of the folder in which to query; if set to -1, the query is for all folders
-
startRow
- the first row in the query to retrieve (row numbers are zero-based)
-
maxRows
- the number of rows in the query to retrieve; if set to -1, all the rows are retrieved
-
sortProperty
- the property on which to sort the query
-
ascending
- whether the sort should be ascending or descending; use true for ascending
-
propsToReturn
- an array of object properties indicating which properties to return in the query
-
filters
- an array of query filters to narrow down the search
Return Value
an IObjectQuery
object that represents the results of the query
Remarks
Returns an IObjectQuery
object that has one row for each object returned. Use caution when creating a query. Queries that result in a large number of objects, e.g. those that query all folders, or queries without query filters, can result in SOAP timeouts, or OutOfMemoryErrors.
Exceptions
Exception Type |
Condition |
HttpException
|
if the query interface URL is not valid |
PortalException
|
if the operation resulted in an error on the portal |
See Also
IObjectManager Interface | Plumtree.Remote.PRC Namespace | IObjectManager.QueryObjects Overload List