Package com.atlassian.confluence.api.service.content

Interface CategoryService

All Known Implementing Classes:

CategoryServiceImpl

public interface CategoryService

Provides operations for Categories.

A Category is a way to group and organize spaces within Confluence.

Since:

9.1

See Also:

• Categories

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CategoryService.Validator	Provides methods for validating category operations.

Method Summary

Modifier and Type	Method	Description
void	addCategory(String spaceKey, String categoryName)	Adds a category to a space's description.
void	removeCategory(String spaceKey, String categoryName)	Removes a category from a space's description.
CategoryService.Validator	validator()	Returns a validator for category operations.

Method Details

addCategory

void addCategory(String spaceKey,
 String categoryName)
          throws ServiceException

Adds a category to a space's description.

Parameters:

spaceKey - the key of the space

categoryName - the name of the category to add

Throws:

ServiceException - if the category cannot be added

Since:

9.3.0

removeCategory

void removeCategory(String spaceKey,
 String categoryName)
             throws ServiceException

Removes a category from a space's description.

Parameters:

spaceKey - the key of the space

categoryName - the name of the category to remove

Throws:

ServiceException - if the category cannot be removed

Since:

9.1

validator

CategoryService.Validator validator()

Returns a validator for category operations.

Returns:

a CategoryService.Validator instance

Since:

9.1