Summary: Methods | [Expand All]
public interface

LabelsService

com.atlassian.confluence.labels.service.LabelsService
Known Indirect Subclasses

Class Overview

Creates label commands

Summary

Public Methods
AddLabelsCommand newAddLabelCommand(String labelString, User user, long entityId, String entityType)
Builds a command that takes a string of comma separated labels and adds them to a Page or Blog Post for the specified user.
AddLabelsCommand newAddLabelCommand(String labelString, 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, User user, long entityId, String entityType)
RemoveLabelCommand newRemoveLabelCommand(String labelIdString, 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, User user, long entityId)
Builds a command that takes removes the specified label Page or Blog Post for the specified user.
RemoveLabelCommand newRemoveLabelCommand(Label label, User user, long entityId)
Builds a command that takes removes the specified label Page or Blog Post for the specified user.
ValidateLabelsCommand newValidateLabelCommand(String labelString, User user)
Builds a command that will validate the labels without actually adding them.

Public Methods

public AddLabelsCommand newAddLabelCommand (String labelString, User user, long entityId, String entityType)

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

public AddLabelsCommand newAddLabelCommand (String labelString, 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 //TODO deprecate

public RemoveLabelCommand newRemoveLabelCommand (Label label, User user, long entityId, String entityType)

public RemoveLabelCommand newRemoveLabelCommand (String labelIdString, 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

public RemoveLabelCommand newRemoveLabelCommand (long labelId, 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

public RemoveLabelCommand newRemoveLabelCommand (Label label, 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

public ValidateLabelsCommand newValidateLabelCommand (String labelString, User user)

Builds a command that will validate the labels without actually adding them.

Parameters
labelString - string of labels
user - logged in user
Returns
  • command