Package com.atlassian.confluence.search.v2.query

Class ContentCategoryQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.ContentCategoryQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class ContentCategoryQuery
extends Object
implements SearchQuery

SearchQuery that finds content where content type is from the list of specified categories

Since:

7.20

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
ContentCategoryQuery(Category contentCategory)	Construct a SearchQuery that finds content matching a given Category
ContentCategoryQuery(Set<Category> contentCategories)	Construct a SearchQuery that finds content matching at least one of the specified Set of Category

Method Summary

Modifier and Type	Method	Description
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
String	getKey()
List<Category>	getParameters()	List of parameters as Strings or SearchQuerys.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery

getBoost, getSubClauses

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

ContentCategoryQuery

public ContentCategoryQuery(Category contentCategory)

Construct a SearchQuery that finds content matching a given Category

Parameters:

contentCategory - Category to match

ContentCategoryQuery

public ContentCategoryQuery(Set<Category> contentCategories)

Construct a SearchQuery that finds content matching at least one of the specified Set of Category

Parameters:

contentCategories - a Set of Category

Throws:

IllegalArgumentException - if contentCategories list is empty

Method Details

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List<Category> getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query