|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentPropertyService
Provides methods for creating, reading, updating and deleting Confluence
JsonContentProperty
objects attached to
Content
objects.
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 |
---|
static final int MAXIMUM_KEY_LENGTH
static final int MAXIMUM_VALUE_LENGTH
static final int MAXIMUM_PROPERTIES_PER_PAGE_REQUEST
Method Detail |
---|
ContentPropertyService.ContentPropertyFinder find(Expansion... expansions)
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.
expansions
- properties to expand
JsonContentProperty create(JsonContentProperty newProperty) throws ServiceException
newProperty
- the content property to create
ServiceException
- if the content property cannot be createdJsonContentProperty update(JsonContentProperty property) throws ServiceException
property
- the updated JsonContentProperty
with metadata about the change
ServiceException
void delete(JsonContentProperty property) throws ServiceException
property
- the content property to remove
ServiceException
- if the content property cannot be found, or cannot be deletedContentPropertyService.Validator validator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |