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

java.lang.Object
  extended by com.atlassian.confluence.search.v2.query.SpaceCategoryQuery
All Implemented Interfaces:
SearchQuery

public class SpaceCategoryQuery
extends Object
implements SearchQuery

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

See Also:
SpaceCategories

Constructor Summary
SpaceCategoryQuery(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
 boolean equals(Object obj)
           
 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
 

Constructor Detail

SpaceCategoryQuery

public SpaceCategoryQuery(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 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()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2003-2012 Atlassian. All Rights Reserved.