org.nuxeo.ecm.core.query

Interface Query

All Known Subinterfaces:

FilterableQuery

public interface Query

Author:

Bogdan Stefanescu, Florent Guillaume

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Query.Type Defines general query types.

Method Summary

Methods

Modifier and Type	Method and Description
QueryResult	execute() Makes a query to the backend.
QueryResult	execute(boolean countTotal) Makes a query to the backend.
QueryResult	execute(long countUpTo) Makes a query to the backend.

Method Detail

execute

QueryResult execute()
                    throws QueryException

Makes a query to the backend. No filter, permission or policy filtering are done.

Returns:

a query result object describing the resulting documents

Throws:

QueryException

See Also:

FilterableQuery#execute(QueryFilter,boolean)}

execute

QueryResult execute(boolean countTotal)
                    throws QueryException

Makes a query to the backend. No filter, permission or policy filtering are done.

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

Parameters:

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

See Also:

FilterableQuery#execute(QueryFilter,boolean)}

execute

QueryResult execute(long countUpTo)
                    throws QueryException

Makes a query to the backend. No filter, permission or policy filtering are done.

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

Parameters:

countUpTo - if -1, also count the total number of documents when no limit/offset is passed.
If 0, don't count the total number of documents.
If n, count the total number if there are less than n documents otherwise set the size to -1.

Returns:

a query result object describing the resulting documents

Throws:

QueryException

Since:

5.6

See Also:

FilterableQuery#execute(QueryFilter,boolean)}