com.atlassian.confluence.labels

Interface SpaceLabelManager

All Known Implementing Classes:

SpaceLabelManagerImpl

public interface SpaceLabelManager

Method Summary

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

Method Detail

addLabel

Label addLabel(Space space,
               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

List getTeamLabelsOnSpace(String spaceKey)

Returns the teams labels for the given space

Returns:

teams labels for the given space

getAvailableTeamLabels

List getAvailableTeamLabels(String spaceKey)

Returns the teams labels available for the given space

Returns:

teams labels available for the given space

getLabelsOnSpace

List getLabelsOnSpace(Space space)

Returns the labels for the given space (excluding team labels)

Returns:

labels for the given space

getSuggestedLabelsForSpace

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