com.atlassian.confluence.labels.service
Interface LabelsService

All Known Implementing Classes:

DefaultLabelsService

public interface LabelsService

Creates label commands

Method Summary

AddLabelsCommand	newAddLabelCommand(String labelString, com.atlassian.user.User user, long entityId) Builds a command that takes a string of comma separated labels and adds them to a Page or Blog Post for the specified user.
RemoveLabelCommand	newRemoveLabelCommand(Label label, com.atlassian.user.User user, long entityId) Builds a command that takes removes the specified label Page or Blog Post for the specified user.
RemoveLabelCommand	newRemoveLabelCommand(long labelId, com.atlassian.user.User user, long entityId) Builds a command that takes removes the specified label Page or Blog Post for the specified user.
RemoveLabelCommand	newRemoveLabelCommand(String labelIdString, com.atlassian.user.User user, long entityId) Builds a command that takes removes the specified label Page or Blog Post for the specified user.

Method Detail

newAddLabelCommand

AddLabelsCommand newAddLabelCommand(String labelString,
                                    com.atlassian.user.User user,
                                    long entityId)

Builds a command that takes a string of comma separated labels and adds them to a Page or Blog Post for the specified user.

Parameters:

labelString - - string of labels

user - - logged in user

entityId - - page or blogpost

Returns:

command

newRemoveLabelCommand

RemoveLabelCommand newRemoveLabelCommand(Label label,
                                         com.atlassian.user.User user,
                                         long entityId)

Builds a command that takes removes the specified label Page or Blog Post for the specified user.

Parameters:

label - - label object

user - - logged in user

entityId - - page or blogpost

Returns:

command

newRemoveLabelCommand

RemoveLabelCommand newRemoveLabelCommand(String labelIdString,
                                         com.atlassian.user.User user,
                                         long entityId)

Builds a command that takes removes the specified label Page or Blog Post for the specified user.

Parameters:

labelIdString - - label id or string

user - - logged in user

entityId - - page or blogpost

Returns:

command

newRemoveLabelCommand

RemoveLabelCommand newRemoveLabelCommand(long labelId,
                                         com.atlassian.user.User user,
                                         long entityId)

Builds a command that takes removes the specified label Page or Blog Post for the specified user.

Parameters:

labelId - - label id

user - - logged in user

entityId - - page or blogpost

Returns:

command