Package com.atlassian.confluence.dmz.labels

Interface LabelManagerInternal

All Superinterfaces:
LabelManager
All Known Implementing Classes:
CachingLabelManager, DefaultLabelManager
public interface LabelManagerInternal extends LabelManager
Internal version of the LabelManager interface; see the package-info.java for rationale.

  • Method Details

    • findGlobalLabelsByNamePrefix

      PageResponse<Label> findGlobalLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)
      Returns global-namespaced labels starting with the given string.

    • findTeamLabelsByNamePrefix

      default PageResponse<Label> findTeamLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)
      Returns team-namespaced labels starting with the given string.

    • findGlobalLabelsByNamePrefix

      default PartialList<Label> findGlobalLabelsByNamePrefix(int offset, int maxResults, String namePrefix)
      Description copied from interface: LabelManager
      Returns global-namespaced labels starting with the given string.
      Specified by:
      findGlobalLabelsByNamePrefix in interface LabelManager
      Since:
      7.17

    • findTeamLabelsByNamePrefix

      default PartialList<Label> findTeamLabelsByNamePrefix(int offset, int maxResults, String namePrefix)
      Description copied from interface: LabelManager
      Returns team-namespaced labels starting with the given string.
      Specified by:
      findTeamLabelsByNamePrefix in interface LabelManager
      Since:
      7.17

    • getLabelsInSpace

      PageResponse<Label> getLabelsInSpace(String key, LimitedRequest pageRequest)
      Get all labels in Space with pagination
      Parameters:
      key -
      pageRequest -
      Returns:
      Since:
      9.2.6

    • getRelatedLabelsInSpace

      PageResponse<Label> getRelatedLabelsInSpace(Label label, String spaceKey, LimitedRequest pageRequest)
      Get related labels in Space with pagination
      Parameters:
      label -
      spaceKey -
      pageRequest -
      Returns:
      Since:
      9.2.6

    • getTotalLabelInSpace

      long getTotalLabelInSpace(String key)
      Get total label in a particular space
      Parameters:
      key -
      Returns:
      Since:
      7.5.0

    • getMostPopularLabelsInSpace

      PageResponse<LabelSearchResult> getMostPopularLabelsInSpace(String key, LimitedRequest limitedRequest)
      Retrieve a list of the 'n' most used labels in the specified space, ordered from most popular to least popular.

      This function does not return the labels itself, but wrapped into a search result with a count!

      Parameters:
      key - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a list of label search result instances in order of their popularity.
      Since:
      9.2.6
      See Also:

    • getMostPopularLabelsInSiteLite

      PageResponse<LiteLabelSearchResult> getMostPopularLabelsInSiteLite(LimitedRequest limitedRequest)
      Returns most used labels across the site. Similar to getMostPopularLabels, but returns lite objects (no references to hibernate objects). Note: implementation would limit the amount of labels.
      Parameters:
      limitedRequest - defines pagination parameters.
      Returns:
      list of LiteLabelSearchResult
      Since:
      10.0.0

    • getMostPopularLabelsInSpaceLite

      PageResponse<LiteLabelSearchResult> getMostPopularLabelsInSpaceLite(String spaceKey, LimitedRequest limitedRequest)
      Returns most used labels. Similar to getMostPopularLabelsInSpace, but returns lite objects (no references to hibernate objects).
      Parameters:
      spaceKey - - space key
      limitedRequest - defines pagination parameters.
      Returns:
      list of LiteLabelSearchResult
      Since:
      10.0.0

    • getRecentlyUsedLabelsInSpace

      PageResponse<Label> getRecentlyUsedLabelsInSpace(String spaceKey, LimitedRequest limitedRequest)
      Retrieve the most recently used labels within the specified space.
      Parameters:
      spaceKey - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with label instances in order of the most recently used to least recently used.
      Since:
      9.2.6
      See Also:

    • getRecentlyUsedLabellingsInSpace

      PageResponse<Labelling> getRecentlyUsedLabellingsInSpace(String spaceKey, LimitedRequest limitedRequest)
      Retrieve the most recently used labellings within the specified space.
      Parameters:
      spaceKey - is the space key.
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with list of labelling instances in order of the most recently used to least recently used.
      Since:
      9.2.6
      See Also:

    • getRecentlyUsedPersonalLabels

      PageResponse<Label> getRecentlyUsedPersonalLabels(String username, LimitedRequest limitedRequest)
      Retrieve the labels that were recently used by currently authenticated user. 'Recently Used' includes labels that the user recently added, created, removed and deleted.

      Note: labels in this list may or may not exist.

      The UserHistory can be retrieved from the session via the ActionContext (if using an action) or the Execution Context (DWR)

      Parameters:
      username - the user history from the session
      limitedRequest - defines pagination parameters.
      Returns:
      a paginated response with list of labels
      Since:
      10.0.0

    • getRecentlyUsedPersonalLabellings

      PageResponse<Labelling> getRecentlyUsedPersonalLabellings(String username, LimitedRequest limitedRequest)

    • getRelatedLabels

      PageResponse<Label> getRelatedLabels(Label label, LimitedRequest limitedRequest)
      Retrieve the labels which are related (i.e. used together) with the specified label.
      Since:
      9.3.0

    • getMostPopularLabels

      PageResponse<LabelSearchResult> getMostPopularLabels(LimitedRequest limitedRequest)
      Returns the most popular global labels in the system. The labels are ordered in descending order of popularity.
      Since:
      9.3.0

    • getRecentlyUsedLabels

      PageResponse<Label> getRecentlyUsedLabels(LimitedRequest limitedRequest)
      Returns the most recently used global labels in the system. The labels are ordered in descending order of the last time it was modified
      Since:
      9.2.4

    • getRecentlyUsedLabellings

      PageResponse<Labelling> getRecentlyUsedLabellings(LimitedRequest limitedRequest)
      Since:
      10.0.0

    • getLabelsByDetail

      PageResponse<Label> getLabelsByDetail(LimitedRequest limitedRequest, String labelName, String namespace, String spaceKey, String owner)
      Returns labels filtered by the given parameters.
      Since:
      9.3.0