@ExperimentalApi
public interface SpacePropertyService
JsonSpaceProperty
objects attached to
Space
objects.Modifier and Type | Interface and Description |
---|---|
static interface |
SpacePropertyService.SpacePropertyFinder |
static interface |
SpacePropertyService.Validator
Provides methods for validating the create, update and delete methods.
|
Modifier and Type | Method and 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() |
JsonSpaceProperty create(JsonSpaceProperty newProperty) throws ServiceException
newProperty
- the property to createServiceException
- if the property cannot be createdSpacePropertyService.SpacePropertyFinder find(Expansion... expansions)
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);
expansions
- properties to expandJsonSpaceProperty update(JsonSpaceProperty property)
property
- the updated JsonSpaceProperty
with metadata about the changevoid delete(JsonSpaceProperty property)
property
- the space property to removeServiceException
- if the space property cannot be found, or cannot be deletedSpacePropertyService.Validator validator()
Copyright © 2003–2018 Atlassian. All rights reserved.