com.atlassian.confluence.labels
Interface SpaceLabelManager

All Known Implementing Classes:
SpaceLabelManagerImpl

public interface SpaceLabelManager


Method Summary
 Label addLabel(Space space, java.lang.String labelName)
          Adds a label to a space.
 java.util.List getAvailableTeamLabels(java.lang.String spaceKey)
          Returns the teams labels available for the given space
 java.util.List getLabelsOnSpace(Space space)
          Returns the labels for the given space (excluding team labels)
 java.util.List getSuggestedLabelsForSpace(Space space, com.atlassian.user.User remoteUser)
          Returns the labels available for the given space (excluding team labels)
 java.util.List getTeamLabelsOnSpace(java.lang.String spaceKey)
          Returns the teams labels for the given space
 

Method Detail

addLabel

Label addLabel(Space space,
               java.lang.String labelName)
Adds a label to a space.

Parameters:
space - space to add label to
labelName - name of the label to be added
Returns:
the label if it was added to the space, null otherwise

getTeamLabelsOnSpace

java.util.List getTeamLabelsOnSpace(java.lang.String spaceKey)
Returns the teams labels for the given space

Returns:
teams labels for the given space

getAvailableTeamLabels

java.util.List getAvailableTeamLabels(java.lang.String spaceKey)
Returns the teams labels available for the given space

Returns:
teams labels available for the given space

getLabelsOnSpace

java.util.List getLabelsOnSpace(Space space)
Returns the labels for the given space (excluding team labels)

Returns:
labels for the given space

getSuggestedLabelsForSpace

java.util.List getSuggestedLabelsForSpace(Space space,
                                          com.atlassian.user.User remoteUser)
Returns the labels available for the given space (excluding team labels)

Parameters:
space - - given space
remoteUser - - logged in user
Returns:
labels available for the given space


Copyright © 2003-2014 Atlassian. All Rights Reserved.