com.atlassian.confluence.api.service.content
Interface ContentLabelService

All Known Implementing Classes:

ContentLabelServiceImpl

@ExperimentalApi
public interface ContentLabelService

API Service for interacting with labels on Content

Since:

5.5

Nested Class Summary

static interface

ContentLabelService.Validator Provides methods for validating actions on the ContentLabelService

Method Summary

PageResponse<Label>	addLabels(ContentId contentId, Iterable<Label> labels) Adds the given labels to the specified content
PageResponse<Label>	getLabels(ContentId contentId, Collection<Label.Prefix> prefixes, PageRequest pageRequest) Get the labels attached to a given piece of content in the given namespaces
ContentLabelService.Validator	validator() Provides a validator for validating actions on the ContentLabelService and checking permissions related to labels on Content

Method Detail

getLabels

PageResponse<Label> getLabels(ContentId contentId,
                              Collection<Label.Prefix> prefixes,
                              PageRequest pageRequest)
                              throws NotFoundException

Get the labels attached to a given piece of content in the given namespaces

Parameters:

contentId - the id of the content to retrieve

prefixes - - the prefixes to filter the returned labels by, if empty no prefix filter is applied

pageRequest - - indicates how many labels to return and from what offset

Returns:

all the labels associated with the given content up to the limit of the page request, or a system defined limit

Throws:

NotFoundException - if the content does not exist, or is not viewable by the user

addLabels

PageResponse<Label> addLabels(ContentId contentId,
                              Iterable<Label> labels)
                              throws ServiceException

Adds the given labels to the specified content

Parameters:

contentId - the id of the content to add labels to

labels - the label(s) that will be added

Returns:

all the labels that are associated with the specified content

Throws:

ServiceException - if at least one label is invalid. Provides an error message

validator

ContentLabelService.Validator validator()

Provides a validator for validating actions on the ContentLabelService and checking permissions related to labels on Content

Returns:

an contentLabelService Validator