com.atlassian.confluence.api.service.content
Interface ContentPropertyService

All Known Implementing Classes:
ContentPropertyServiceImpl

public interface ContentPropertyService

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

Since:
5.6

Nested Class Summary
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
static int MAXIMUM_KEY_LENGTH
           
static int MAXIMUM_PROPERTIES_PER_PAGE_REQUEST
           
static int MAXIMUM_VALUE_LENGTH
           
 
Method Summary
 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 Detail

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 Detail

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

create

JsonContentProperty create(JsonContentProperty newProperty)
                           throws ServiceException
Create a content property.

Parameters:
newProperty - the content property to create
Returns:
the content property created
Throws:
ServiceException - if the content property cannot be created

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

validator

ContentPropertyService.Validator validator()
Returns:
the validator view of the ContentPropertyService.


Copyright © 2003–2015 Atlassian. All rights reserved.