com.atlassian.confluence.search
Class SpacePickerHelper

java.lang.Object
  extended by com.atlassian.confluence.search.SpacePickerHelper

public class SpacePickerHelper
extends Object


Nested Class Summary
 class SpacePickerHelper.SpaceDTO
           
 
Constructor Summary
SpacePickerHelper(SpaceManager spaceManager, LabelManager labelManager)
           
 
Method Summary
 List<com.atlassian.core.util.PairType> getAggregateOptions(com.opensymphony.xwork.ActionSupport action)
           
 List<SpacePickerHelper.SpaceDTO> getAvailableGlobalSpaces(ConfluenceUser user)
          Gets a list of current (non-archived) global space keys and names, not including any of the user's favourite spaces.
 List<SpacePickerHelper.SpaceDTO> getAvailableGlobalSpaces(com.atlassian.user.User user)
          Deprecated. since 5.2. See getAvailableGlobalSpaces(ConfluenceUser) instead.
 List<SpacePickerHelper.SpaceDTO> getFavouriteSpaces(com.atlassian.user.User user)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpacePickerHelper

public SpacePickerHelper(SpaceManager spaceManager,
                         LabelManager labelManager)
Method Detail

getAvailableGlobalSpaces

@Deprecated
public List<SpacePickerHelper.SpaceDTO> getAvailableGlobalSpaces(com.atlassian.user.User user)
Deprecated. since 5.2. See getAvailableGlobalSpaces(ConfluenceUser) instead.

Gets a list of current (non-archived) global space keys and names, not including any of the user's favourite spaces. If the name of the space is longer than MAX_SPACE_NAME_LENGTH, it will be shortened for display.

Parameters:
user - the user for which to generate the list, or null for the anonymous user
Returns:
A list of pairs of the space key, and shortened space name.

getAvailableGlobalSpaces

public List<SpacePickerHelper.SpaceDTO> getAvailableGlobalSpaces(ConfluenceUser user)
Gets a list of current (non-archived) global space keys and names, not including any of the user's favourite spaces. If the name of the space is longer than MAX_SPACE_NAME_LENGTH, it will be shortened for display.

Parameters:
user - the user for which to generate the list, or null for the anonymous user
Returns:
A list of pairs of the space key, and shortened space name.

getAggregateOptions

public List<com.atlassian.core.util.PairType> getAggregateOptions(com.opensymphony.xwork.ActionSupport action)

getFavouriteSpaces

public List<SpacePickerHelper.SpaceDTO> getFavouriteSpaces(com.atlassian.user.User user)


Copyright © 2003–2015 Atlassian. All rights reserved.