com.atlassian.confluence.search.scope
Class SpaceScope

java.lang.Object
  com.atlassian.confluence.search.scope.SpaceScope

All Implemented Interfaces:

ConfluenceSearchScope

public class SpaceScope
extends Object
implements ConfluenceSearchScope

Searcher that limits a search by space. If you provide an empty list of spaces, the search will be performed across All spaces.

Field Summary

static String	ALL
static List	AVAILABLE_SCOPES A definitive list off all existing space scope strings.
static String	FAVOURITES
static String	GLOBAL
static String	PERSONAL
static String	SCOPE_PREFIX

Constructor Summary

SpaceScope(List spaceKeys, LabelManager labelManager)

SpaceScope(String spaceKey, LabelManager labelManager)

Method Summary

static SpaceScope	fromSpaceList(List spaces, List spaceScopes, LabelManager labelManager)
LabelManager	getLabelManager()
void	restrictQuery(com.atlassian.user.User user, org.apache.lucene.search.BooleanQuery query)
void	setLabelManager(LabelManager labelManager)

Methods inherited from class java.lang.Object

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

Field Detail

SCOPE_PREFIX

public static final String SCOPE_PREFIX

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

FAVOURITES

public static final String FAVOURITES

See Also:

Constant Field Values

GLOBAL

public static final String GLOBAL

See Also:

Constant Field Values

PERSONAL

public static final String PERSONAL

See Also:

Constant Field Values

AVAILABLE_SCOPES

public static final List AVAILABLE_SCOPES

A definitive list off all existing space scope strings.

Constructor Detail

SpaceScope

public SpaceScope(String spaceKey,
                  LabelManager labelManager)

SpaceScope

public SpaceScope(List spaceKeys,
                  LabelManager labelManager)

Method Detail

fromSpaceList

public static SpaceScope fromSpaceList(List spaces,
                                       List spaceScopes,
                                       LabelManager labelManager)

restrictQuery

public void restrictQuery(com.atlassian.user.User user,
                          org.apache.lucene.search.BooleanQuery query)

Specified by:

restrictQuery in interface ConfluenceSearchScope

getLabelManager

public LabelManager getLabelManager()

setLabelManager

public void setLabelManager(LabelManager labelManager)