  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Examples
Overview
References

Overview

This is a filter class that groups all the information needed to perform a search in the system. It includes: filtering predicates, sort criteria, pagination, and projection to be used for the returned match entities. It also contains a parameter to control whether search service should estimate a hits-count value.

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.

Members

Show inherited members

Name	Type	Description
countLimit	int
includeEstimatedHitsCount	boolean	Returns true if estimated hit-counts is required. If not set, the default is false.
predicate	predicate
projection	anyType	Returns the Projection to be used for the returned matching Entities.
snippetCountLimit	int	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.
sortCriteria	sortCriteria
startIndex	int

Hierarchy

Inherits From

paginatedPredicateAndSortListParameters

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:searchListParameters xsi:type="obh:searchListParameters" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:countLimit>your_int_0</obh:countLimit>
        <obh:includeEstimatedHitsCount>your_boolean_0</obh:includeEstimatedHitsCount>
        <obh:predicate>your_predicate_0</obh:predicate>
        <obh:projection>your_anyType_0</obh:projection>
        <obh:snippetCountLimit>your_int_0</obh:snippetCountLimit>
        <obh:sortCriteria>your_sortCriteria_0</obh:sortCriteria>
        <obh:startIndex>your_int_0</obh:startIndex>
</obh:searchListParameters>

JSON Example

(show inherited members)

{
    "beeType":"searchListParameters",
        "countLimit":your_{http://www.oracle.com/beehive}countLimit_as_int0,
        "includeEstimatedHitsCount":your_{http://www.oracle.com/beehive}includeEstimatedHitsCount_as_boolean0,
        "predicate":{ your_{http://www.oracle.com/beehive}predicate_as_predicate0 },
        "projection":"your_{http://www.oracle.com/beehive}projection_as_anyType0",
        "snippetCountLimit":your_{http://www.oracle.com/beehive}snippetCountLimit_as_int0,
        "sortCriteria":{ your_{http://www.oracle.com/beehive}sortCriteria_as_sortCriteria0 },
        "startIndex":your_{http://www.oracle.com/beehive}startIndex_as_int0
}

XML Schema


<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>

References

The following data represents the references to searchListParameters

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations