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

java.lang.Object
  com.atlassian.confluence.search.v2.query.AbstractParameterListQuery<String>
      com.atlassian.confluence.search.v2.query.InSpaceQuery

All Implemented Interfaces:

SearchQuery

public class InSpaceQuery
extends AbstractParameterListQuery<String>

Search for content that occurs within some set of spaces.

Field Summary

Fields inherited from class com.atlassian.confluence.search.v2.query.AbstractParameterListQuery

parameters

Constructor Summary

InSpaceQuery(Set<String> spaceKeys)
Search for content within any of a collection of spaces with given keys

InSpaceQuery(String spaceKey)
Search for content within a single space with the given key

Method Summary

String

getKey()

Methods inherited from class com.atlassian.confluence.search.v2.query.AbstractParameterListQuery

equals, getParameters, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

InSpaceQuery

public InSpaceQuery(String spaceKey)

Search for content within a single space with the given key

Parameters:

spaceKey - the key of the space to search within

InSpaceQuery

public InSpaceQuery(Set<String> spaceKeys)

Search for content within any of a collection of spaces with given keys

Parameters:

spaceKeys - a set of the keys of the spaces to search within

Method Detail

getKey

public String getKey()

Returns:

the plugin key