com.atlassian.confluence.legacyapi.service.content

Interface TemplateService

All Known Implementing Classes:

LegacyTemplateServiceImpl

public interface TemplateService

Method Summary

Modifier and Type	Method and Description
Iterable<Label>	addLabels(long pageTemplateId, Iterable<Label> labels) Adds the given labels to the specified content
Iterable<Label>	getLabels(long pageTemplateId, Collection<Label.Prefix> prefixes) Get the labels attached to a given page template
void	removeLabel(long pageTemplateId, long labelId) Remove a label with labelId from the specified content

Method Detail

getLabels

Iterable<Label> getLabels(long pageTemplateId,
                          Collection<Label.Prefix> prefixes)
                   throws NotFoundException

Get the labels attached to a given page template

Parameters:

pageTemplateId - id of the page template to fetch labels for.

Throws:

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

addLabels

Iterable<Label> addLabels(long pageTemplateId,
                          Iterable<Label> labels)
                   throws IllegalArgumentException

Adds the given labels to the specified content

Parameters:

pageTemplateId - 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:

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

removeLabel

void removeLabel(long pageTemplateId,
                 long labelId)
          throws IllegalArgumentException

Remove a label with labelId from the specified content

Parameters:

pageTemplateId - the id of the content to remove the label from

labelId - the id of the label to remove

Throws:

IllegalArgumentException - failed to remove the label