Package com.atlassian.confluence.labels.service

Interface LabelsService

All Known Implementing Classes:
DefaultLabelsService
public interface LabelsService
Creates label commands

  • Method Details

    • newAddLabelCommand

      AddLabelsCommand newAddLabelCommand(String labelString, ConfluenceUser 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

    • newAddLabelCommand

      AddLabelsCommand newAddLabelCommand(String labelString, ConfluenceUser 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
      String - entityType - the type of entity to label one of: CONTENT, SPACE, ATTACHMENT
      Returns:
      command

    • newValidateLabelCommand

      ValidateLabelsCommand newValidateLabelCommand(String labelString, ConfluenceUser user)
      Builds a command that will validate the labels without actually adding them.
      Parameters:
      labelString - - string of labels
      user - - logged in user
      Returns:
      command

    • newRemoveLabelCommand

      RemoveLabelCommand newRemoveLabelCommand(Label label, ConfluenceUser 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(Label label, ConfluenceUser user, long entityId, String entityType)

    • newRemoveLabelCommand

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