Interface LabelService
- All Known Implementing Classes:
LabelServiceImpl
public interface LabelService
Provides operations for Labels.
- Since:
- 9.1
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceProvides methods for validating inputs to create, retrieve, update or delete labels. -
Method Summary
Modifier and TypeMethodDescriptiongetRecentlyUsedLabels(PageRequest pageRequest) Returns a paginated list of the most recent Labels used in a Confluence instance.getRelatedLabels(String labelName, int maxCount) Deprecated.getRelatedLabels(String labelName, PageRequest pageRequest) Returns the labels related to the given label name, with a specified maximum number of results.Get the validator view ofLabelService.
-
Method Details
-
getRelatedLabels
@Deprecated PageResponse<Label> getRelatedLabels(String labelName, int maxCount) throws BadRequestException, NotFoundException Deprecated.since 9.2.3, usegetRelatedLabels(String, PageRequest)instead.- Throws:
BadRequestExceptionNotFoundException
-
getRelatedLabels
PageResponse<Label> getRelatedLabels(String labelName, PageRequest pageRequest) throws BadRequestException, NotFoundException Returns the labels related to the given label name, with a specified maximum number of results. Returns global labels only, i.e. label.namespace = 'global', with current retrieval logic in com.atlassian.confluence.labels.DefaultLabelManager#getRelatedLabels(com.atlassian.confluence.labels.Label, int), which may change in the future.- Parameters:
labelName- The name of the label (namespace prefixes permitted)pageRequest- the pagination parameters.- Returns:
PageResponsewith a list of related labels as its result, sorted by frequency of use.- Throws:
BadRequestException- if the given label name is invalid, e.g. null, empty, or un-parsableNotFoundException- if the given label name cannot be found- Since:
- 9.2.3
-
getRecentlyUsedLabels
Returns a paginated list of the most recent Labels used in a Confluence instance.- Parameters:
pageRequest- the pagination parameters.- Returns:
- Paginated list of labels.
- Since:
- 9.1.0
-
validator
LabelService.Validator validator()Get the validator view ofLabelService.
-
getRelatedLabels(String, PageRequest)instead.