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

Interface ContentPropertyService

All Known Implementing Classes:

ContentPropertyServiceImpl, MockContentPropertyService

public interface ContentPropertyService

Provides methods for creating, reading, updating and deleting Confluence JsonContentProperty objects attached to Content objects.

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ContentPropertyService.ContentPropertyFetcher
static interface	ContentPropertyService.ContentPropertyFinder
static interface	ContentPropertyService.ParameterContentPropertyFinder
static interface	ContentPropertyService.SingleContentPropertyFetcher
static interface	ContentPropertyService.Validator	Provides methods for validating the create, update and delete methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXIMUM_KEY_LENGTH
static final int	MAXIMUM_PROPERTIES_PER_PAGE_REQUEST
static final int	MAXIMUM_VALUE_LENGTH

Method Summary

Modifier and Type	Method	Description
default void	copyAllJsonContentProperties(ContentSelector source, ContentSelector target)	Copy all JsonContentProperty from one content to other content, default implementation do nothing
JsonContentProperty	create(JsonContentProperty newProperty)	Create a content property.
void	delete(JsonContentProperty property)	Removes a content property from the system.
ContentPropertyService.ContentPropertyFinder	find(Expansion... expansions)	Create a ContentPropertyService.ContentPropertyFinder for locating content, the expansions will be applied to each property that matches the finder.
JsonContentProperty	update(JsonContentProperty property)	Updates a content property.
ContentPropertyService.Validator	validator()

Field Details

MAXIMUM_KEY_LENGTH

static final int MAXIMUM_KEY_LENGTH

See Also:

• Constant Field Values

MAXIMUM_VALUE_LENGTH

static final int MAXIMUM_VALUE_LENGTH

See Also:

• Constant Field Values

MAXIMUM_PROPERTIES_PER_PAGE_REQUEST

static final int MAXIMUM_PROPERTIES_PER_PAGE_REQUEST

See Also:

• Constant Field Values

Method Details

create

JsonContentProperty create(JsonContentProperty 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

ContentPropertyService.ContentPropertyFinder find(Expansion... expansions)

Create a ContentPropertyService.ContentPropertyFinder for locating content, the expansions will be applied to each property that matches the finder. JsonContentProperty objects will be retrieved by using the fetch methods on the returned ContentPropertyFinder.

Parameters:

expansions - properties to expand

Returns:

the finder

update

JsonContentProperty update(JsonContentProperty property)
                    throws ServiceException

Updates a content property.

Parameters:

property - the updated JsonContentProperty with metadata about the change

Returns:

the updated content after being persisted

Throws:

ServiceException

delete

void delete(JsonContentProperty property)
     throws ServiceException

Removes a content property from the system.

Parameters:

property - the content property to remove

Throws:

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

copyAllJsonContentProperties

default void copyAllJsonContentProperties(ContentSelector source,
 ContentSelector target)
                                   throws ServiceException

Copy all JsonContentProperty from one content to other content, default implementation do nothing

Parameters:

source - Content Selector of Content want to copy from

target - Content Selector of Content want to copy to

Throws:

ServiceException

Since:

7.19.6

validator

ContentPropertyService.Validator validator()

Returns:

the validator view of the ContentPropertyService.