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

Interface SpacePropertyService

All Known Implementing Classes:

SpacePropertyServiceImpl

public interface SpacePropertyService

Provides methods for creating and reading Confluence JsonSpaceProperty objects attached to Space objects.

Since:

5.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SpacePropertyService.SpacePropertyFinder
static interface	SpacePropertyService.Validator	Provides methods for validating the create, update and delete methods.

Method Summary

Modifier and Type	Method	Description
JsonSpaceProperty	create(JsonSpaceProperty newProperty)	Create a content property.
void	delete(JsonSpaceProperty property)	Removes a space property from the system.
SpacePropertyService.SpacePropertyFinder	find(Expansion... expansions)	Create a SpacePropertyService.SpacePropertyFinder for locating properties, the expansions will be applied to each property that matches the finder.
JsonSpaceProperty	update(JsonSpaceProperty property)	Updates a space property.
SpacePropertyService.Validator	validator()

Method Details

create

JsonSpaceProperty create(JsonSpaceProperty newProperty)
                  throws ServiceException

Create a content property.

Parameters:

newProperty - the property to create

Returns:

the property created

Throws:

ServiceException - if the property cannot be created

find

SpacePropertyService.SpacePropertyFinder find(Expansion... expansions)

Create a SpacePropertyService.SpacePropertyFinder for locating properties, the expansions will be applied to each property that matches the finder. JsonSpaceProperty objects will be retrieved by using the fetch methods on the returned SpacePropertyFinder. * For example:

 spaceService.find()
      .withSpaceKey("DEV")
      .fetchMany(new SimplePageRequest(0, 10);
 
 

Parameters:

expansions - properties to expand

Returns:

the finder

update

JsonSpaceProperty update(JsonSpaceProperty property)

Updates a space property.

Parameters:

property - the updated JsonSpaceProperty with metadata about the change

Returns:

the updated space property after being persisted

delete

void delete(JsonSpaceProperty property)

Removes a space property from the system.

Parameters:

property - the space property to remove

Throws:

ServiceException - if the space property cannot be found, or cannot be deleted

validator

SpacePropertyService.Validator validator()

Returns:

the validator view of the SpacePropertyService.