com.atlassian.confluence.search.v2
Interface SearchQuery

All Known Implementing Classes:

AllQuery, AndQuery, ContentTypeQuery, DateModifiedQuery, FavouriteSpaceQuery, InSpaceQuery, LabelQuery, OrQuery, SpaceTypeQuery

public interface SearchQuery

A query to be performed against the search index. Implementations should be immutable.

Queries consist of a key (a unique string, usually a plugin module complete key, to identify the type of query being performed) and a list of parameters which may either be strings, or other instances of SearchQuery. All query implementations must have a constructor that takes a list of Strings and/or SearchQuerys, that it can then translate into its own query parameters. For invalid queries, the constructor should throw a RuntimeException (i.e. NullPointerException, ClassCastException, IllegalArgumentException).

Method Summary

java.lang.String	getKey()
java.util.List	getParameters() List of parameters as Strings or SearchQuerys.

Method Detail

getKey

java.lang.String getKey()

getParameters

java.util.List getParameters()

List of parameters as Strings or SearchQuerys.

Returns:

Strings or SearchQuerys.