Interface RestSpaceManager
-
- All Known Implementing Classes:
DefaultRestSpaceManager
public interface RestSpaceManagerResponsible for managingSpaceEntityobjects.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SpaceEntityexpand(SpaceEntity spaceEntity)Expands and returns the givenSpaceEntity.SpaceEntitygetSpaceEntity(String spaceKey, boolean expand)Gets theSpaceEntityfor the given spaceKey and expands it if necessary.SpaceEntityListgetSpaceEntityList(SpaceEntityListContext ctx)Gets theSpaceEntityListfor the givenSpaceEntityListContext.
-
-
-
Method Detail
-
getSpaceEntity
SpaceEntity getSpaceEntity(String spaceKey, boolean expand)
Gets theSpaceEntityfor the given spaceKey and expands it if necessary.It is responsible for doing any permission checking and conversion from Confluence's
Spaceto aSpaceEntity.nullis returned, if the current user is not permitted to view the space.- Parameters:
spaceKey- the space key of the space to retrieveexpand- whether to expand the space entity
-
getSpaceEntityList
SpaceEntityList getSpaceEntityList(SpaceEntityListContext ctx)
Gets theSpaceEntityListfor the givenSpaceEntityListContext.It is up to the implementation to decide on default behaviour when values for in the context are not specified. The context passed in however, must not be null.
- Parameters:
ctx- the context for which the space entity list is retrieved in
-
expand
SpaceEntity expand(SpaceEntity spaceEntity)
Expands and returns the givenSpaceEntity.- Parameters:
spaceEntity- the space entity to expand- Returns:
- the expanded space entity
-
-