Package com.atlassian.confluence.dmz.labels

Interface LabelManagerInternal

All Superinterfaces:

LabelManager

All Known Implementing Classes:

CachingLabelManager, DefaultLabelManager

@Transactional(readOnly=true)
public interface LabelManagerInternal
extends LabelManager

Internal version of the LabelManager interface; see the package-info.java for rationale.

Field Summary

Fields inherited from interface com.atlassian.confluence.labels.LabelManager

CONTENT_TYPES, DEFAULT_LABEL_COUNT, FAVOURITE_LABEL, FAVOURITE_LABEL_YANKEE, LABEL_ADDED, LABEL_CREATED, LABEL_DELETED, LABEL_REMOVED, NO_CHANGE, NO_MAX_RESULTS, NO_OFFSET

Method Summary

Modifier and Type	Method	Description
default PartialList<Label>	findGlobalLabelsByNamePrefix(int offset, int maxResults, String namePrefix)	Returns global-namespaced labels starting with the given string.
PageResponse<Label>	findGlobalLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)	Returns global-namespaced labels starting with the given string.
default PartialList<Label>	findTeamLabelsByNamePrefix(int offset, int maxResults, String namePrefix)	Returns team-namespaced labels starting with the given string.
default PageResponse<Label>	findTeamLabelsByNamePrefix(String namePrefix, LimitedRequest pageRequest)	Returns team-namespaced labels starting with the given string.
PageResponse<Label>	getLabelsByDetail(LimitedRequest limitedRequest, String labelName, String namespace, String spaceKey, String owner)	Returns labels filtered by the given parameters.
PageResponse<Label>	getLabelsInSpace(String key, LimitedRequest pageRequest)	Get all labels in Space with pagination
PageResponse<LabelSearchResult>	getMostPopularLabels(LimitedRequest limitedRequest)	Returns the most popular global labels in the system.
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.
PageResponse<Labelling>	getRecentlyUsedLabellingsInSpace(String spaceKey, LimitedRequest limitedRequest)	Retrieve the most recently used labellings within the specified space.
PageResponse<Label>	getRecentlyUsedLabels(LimitedRequest limitedRequest)	Returns the most recently used global labels in the system.
PageResponse<Label>	getRecentlyUsedLabelsInSpace(String spaceKey, LimitedRequest limitedRequest)	Retrieve the most recently used labels within the specified space.
PageResponse<Label>	getRelatedLabels(Label label, LimitedRequest limitedRequest)	Retrieve the labels which are related (i.e.
PageResponse<Label>	getRelatedLabelsInSpace(Label label, String spaceKey, LimitedRequest pageRequest)	Get related labels in Space with pagination
long	getTotalLabelInSpace(String key)	Get total label in a particular space

Methods inherited from interface com.atlassian.confluence.labels.LabelManager

addLabel, calculateRanksForLiteLabels, createLabel, deleteLabel, deleteLabel, getAllContentForAllLabels, getAllContentForLabel, getContent, getContentCount, getContentForAllLabels, getContentForAllLabels, getContentForLabel, getContentInSpaceForAllLabels, getContentInSpaceForLabel, getContentInSpacesForAllLabels, getCurrentContentForLabel, getCurrentContentForLabelAndSpace, getCurrentContentWithPersonalLabel, getFavouriteLabellingsByContentIds, getFavouriteSpaces, getForLabel, getForLabels, getForLabels, getLabel, getLabel, getLabel, getLabel, getLabel, getLabels, getLabelsByDetail, getLabelsInSpace, getMostPopularLabels, getMostPopularLabels, getMostPopularLabelsInSiteLite, getMostPopularLabelsInSpace, getMostPopularLabelsInSpace, getMostPopularLabelsInSpaceLite, getMostPopularLabelsWithRanks, getMostPopularLabelsWithRanks, getMostPopularLabelsWithRanksInSpace, getRecentlyUsedLabellings, getRecentlyUsedLabellingsInSpace, getRecentlyUsedLabels, getRecentlyUsedLabels, getRecentlyUsedLabelsInSpace, getRecentlyUsedLabelsInSpace, getRecentlyUsedPersonalLabellings, getRecentlyUsedPersonalLabels, getRecentlyUsedPersonalLabels, getRelatedLabels, getRelatedLabels, getRelatedLabels, getRelatedLabelsInSpace, getRelatedLabelsInSpace, getSpacesContainingContentWithLabel, getSpacesWithLabel, getSuggestedLabels, getSuggestedLabels, getSuggestedLabelsInSpace, getSuggestedLabelsInSpace, getTeamLabels, getTeamLabels, getTeamLabelsForSpace, getTeamLabelsForSpaces, getUsersLabels, removeAllLabels, removeLabel, removeLabels

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:

• LabelSearchResult

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:

• Label

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:

• Labelling

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

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