|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface ContentLabelService
API Service for interacting with labels on Content
Nested Class Summary | |
---|---|
static interface |
ContentLabelService.Validator
Provides methods for validating actions on the ContentLabelService |
Method Summary | |
---|---|
PageResponse<Label> |
addLabels(ContentId contentId,
java.lang.Iterable<Label> labels)
Adds the given labels to the specified content |
PageResponse<Label> |
getLabels(ContentId contentId,
java.util.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 |
---|
PageResponse<Label> getLabels(ContentId contentId, java.util.Collection<Label.Prefix> prefixes, PageRequest pageRequest) throws NotFoundException
contentId
- the id of the content to retrieveprefixes
- - the prefixes to filter the returned labels by, if empty no prefix filter is appliedpageRequest
- - indicates how many labels to return and from what offset
NotFoundException
- if the content does not exist, or is not viewable by the userPageResponse<Label> addLabels(ContentId contentId, java.lang.Iterable<Label> labels) throws ServiceException
contentId
- the id of the content to add labels tolabels
- the label(s) that will be added
ServiceException
- if at least one label is invalid. Provides an error messageContentLabelService.Validator validator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |