com.atlassian.confluence.search.v2.query

Class SpaceCategoryQuery

java.lang.Object

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

All Implemented Interfaces:

SearchQuery

public class SpaceCategoryQuery
extends java.lang.Object
implements SearchQuery

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

See Also:

SpaceCategories

Constructor Summary

Constructors

Constructor and Description
SpaceCategoryQuery(java.util.Set<SpaceCategoryEnum> categories) Search for content within all spaces represented by the provided categories.
SpaceCategoryQuery(SpaceCategoryEnum category) Search for content within all spaces represented by the specified category.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getKey()
java.util.List<java.lang.String>	getParameters() List of parameters as Strings or SearchQuerys.
java.util.Set<SpaceCategoryEnum>	getSpaceCategories()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceCategoryQuery

public SpaceCategoryQuery(java.util.Set<SpaceCategoryEnum> categories)

Search for content within all spaces represented by the provided categories.

Parameters:

categories - the string representation of the category of space to search within.

SpaceCategoryQuery

public SpaceCategoryQuery(SpaceCategoryEnum category)

Search for content within all spaces represented by the specified category.

Parameters:

category - the category to search within

Method Detail

getKey

public java.lang.String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public java.util.List<java.lang.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 java.util.Set<SpaceCategoryEnum> getSpaceCategories()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object