@PublicApi public interface


Known Indirect Subclasses


This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

The representation of a query.

Public Methods

public OrderBy getOrderByClause ()

  • the sorting portion of the search which can be any number of SearchSorts that will make up the full order by clause. Null indicates that no order by clause has been entered and we will not sort the query, empty sorts will cause the default sorts to be used.

public String getQueryString ()

  • the original query string that the user inputted into the system. If not provided, will return null.

public Clause getWhereClause ()

  • the main clause of the search which can be any number of nested clauses that will make up the full search query. Null indicates that no where clause is available and all issues should be returned.