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

Class SpaceCategoryQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.SpaceCategoryQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class SpaceCategoryQuery
extends Object
implements SearchQuery

Search for content within spaces of a particular category (or categories).

See Also:

SpaceCategories

Constructor Summary

Constructors

Constructor	Description
SpaceCategoryQuery(SpaceCategoryEnum category, LabelManager labelManager)
SpaceCategoryQuery(Collection<SpaceCategoryEnum> categories, LabelManager labelManager)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
String	getKey()
List<String>	getParameters()	List of parameters as Strings or SearchQuerys.
Set<SpaceCategoryEnum>	getSpaceCategories()
int	hashCode()

Methods inherited from class java.lang.Object

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

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

getBoost, getSubClauses

Constructor Detail

SpaceCategoryQuery

public SpaceCategoryQuery(Collection<SpaceCategoryEnum> categories,
                          LabelManager labelManager)

SpaceCategoryQuery

public SpaceCategoryQuery(SpaceCategoryEnum category,
                          LabelManager labelManager)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List<String> getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

getSpaceCategories

public Set<SpaceCategoryEnum> getSpaceCategories()

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object