| | WebCenter Interaction API | |
| IPTObjectManager.Query Method (Int32, Int32, Int32[][], Int32, Int32, Object[][]) |
Perform a query for objects of this type. The query supports filtering, sorting, etc.
IPTQueryResult Query(
int
nPropIDMask,
int
lFolderID,
int[][]
vOrderBy,
int
nSkipRows,
int
nMaxRows,
object[][]
vQueryFilter);
Parameters
-
nPropIDMask
- a bitmask of PT_PROPIDS values that indicates what properties should appear in the IPTQueryResult result
-
lFolderID
- the folder whose contents are being queried, or -1 for all folders
-
vOrderBy
- a 2D array specifying how results should be ordered. The first column holds the PT_PROPIDS by which to order, and the second column holds the order direction, from PT_ORDERBY_SETTINGS. Multiple rows can be included for multi-level ordering, but a maximum of three rows will be respected.
-
nSkipRows
- number of rows to skip at the beginning, or 0 for none
-
nMaxRows
- maximum number of rows to return, or -1 for all
-
vQueryFilter
- is a 2D array with 3 columns. The first column holds the property id, from PT_PROPIDS. The second column holds the operator, from PT_FILTEROPS. The third column holds the value to be matched.
Return Value
an IPTQueryResult that holds the requested records
See Also
IPTObjectManager Interface | com.plumtree.server Namespace | IPTObjectManager.Query Overload List