org.nuxeo.ecm.core.query
Interface FilterableQuery

All Superinterfaces:

Query

public interface FilterableQuery
extends Query

A Query that can be executed with an additional QueryFilter.

Author:

Florent Guillaume

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.query.Query

Query.Type

Method Summary

QueryResult

execute(QueryFilter queryFilter, boolean countTotal) Makes a query to the backend with filtering on the BROWSE permission for the principal, facets, and query transformers.

Methods inherited from interface org.nuxeo.ecm.core.query.Query

execute, execute

Method Detail

execute

QueryResult execute(QueryFilter queryFilter,
                    boolean countTotal)
                    throws QueryException

Makes a query to the backend with filtering on the BROWSE permission for the principal, facets, and query transformers.

The total number of documents can also be retrieved, it is then stored in the DocumentModelList returned by QueryResult.getDocumentModels().

Parameters:

queryFilter - the query filter

countTotal - if true, also count the total number of documents when no limit/offset is passed

Returns:

a query result object describing the resulting documents

Throws:

QueryException