com.ibm.rational.wvcm.stp.cq
Interface CqQuery.CommonOptions
- All Known Subinterfaces:
- CqQuery.ChartOptions, CqQuery.ListOptions
- All Known Implementing Classes:
- CqQuery.ChartOptionsClass, CqQuery.ListOptionsClass
- Enclosing interface:
- CqQuery
public static interface CqQuery.CommonOptions
An interface specifying a set of optional parameters that may be passed
to
CqQuery.doExecute
,
CqQuery.doMakeChart
,
CqRecordType.doQuery
,
or
CqReport.doMakeReport
to control the execution of queries and the generation of charts and
reports.
Each method returns a value for one parameter. If that method returns
null a system-defined default value will be used as the value for
that parameter.
getQueryPropertyRequest
PropertyRequestItem.PropertyRequest getQueryPropertyRequest()
- Returns:
- The properties of the query being executed that should be
retrieved and returned with the result set. If null,
CqResultSet().getQuery will return null; otherwise it
will return a CqQuery proxy populated with the properties
requested.
- See Also:
CqResultSet.getQuery()
getRowNumberLimit
Long getRowNumberLimit()
- Returns:
- The largest row number that the query may return. This is the
maximum number of rows allowed in the result set only
if the
targetRow
parameter is 1. In general,
the maximum number of rows returned by an execution of the
query will be the smallest of
- the
maxRows
parameter,
- the value of
1+getRowNumberLimit()-targetRow
, and
1+CqResultSet.getRowNumberHardLimit()-targetRows
. If null, the value of
CqResultSet.getRowNumberSoftLimit() will be used. - See Also:
CqResultSet.getRowNumberHardLimit()
,
CqResultSet.getRowNumberSoftLimit()
,
CqResultSet.isRowNumberLimitExceeded()
Copyright © IBM 2008. All rights reserved.