Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7) E16658-04 |
After creating an object of this class, clients must explicitly initialize the predicate, the projection, and the count-limit.
When not explicitly set, the default sort criteria is by relevancy (based on internal scoring); the default start index is one; default snippet-count-limit is NULL (equivalent to the value used by count-limit); the default estimate-hits-count flag is set to false.
Name | Type | Required | Description |
---|---|---|---|
includeEstimatedHitsCount |
Returns true if estimated hit-counts is required. If not set, the default is false. | ||
projection |
Returns the Projection to be used for the returned matching Entities. | ||
snippetCountLimit |
Returns count limit for snippet computation. Null value or -1 will be treated as default, in which case, if snippet is set to be computed (depending on the projection), the search API will compute snippet for all returned matches. For non-null value other than -1, it must be non-negative. The search API will return up to the number of getCountLimit matched entities. Among the returned set, snippet is computed for the first N matches provided that N is the value returned by this getSnippetCountLimit(). If, based on projection setting, snippet is not to be computed, then this field is ignored. |
Inherits From
<xs:complexType name="searchListParameters"> <xs:complexContent> <xs:extension base="tns:paginatedPredicateAndSortListParameters"> <xs:sequence> <xs:element name="includeEstimatedHitsCount" type="xs:boolean"/> <xs:element minOccurs="0" name="projection" type="xs:anyType"/> <xs:element minOccurs="0" name="snippetCountLimit" type="xs:int"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices