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


@ExperimentalApi
public interface SpaceService

Provides CRUD operations on Spaces.


Method Summary
 PageResponse<Content> getContent(Space space, PageRequest pageRequest, Expansion... expansion)
          Retrieve the top level content contained in this space.
 com.atlassian.fugue.Option<Space> getSpace(java.lang.String spaceKey, Expansion... expansions)
          Retrieve a space with the given spacekey.
 

Method Detail

getSpace

com.atlassian.fugue.Option<Space> getSpace(java.lang.String spaceKey,
                                           Expansion... expansions)
Retrieve a space with the given spacekey. A space key uniquely identifies a space.

Parameters:
spaceKey - - the space key of the space
Returns:
an Option of the space with the given key if one exists.

getContent

PageResponse<Content> getContent(Space space,
                                 PageRequest pageRequest,
                                 Expansion... expansion)
Retrieve the top level content contained in this space.

The pageRequest limit is restricted to a maximum page size.

Parameters:
space - - the space to retrieve the content for
pageRequest - - a pageRequest indicating how much content to retrieve.
Returns:
a partial list of the top level content in this space.


Copyright © 2003-2014 Atlassian. All Rights Reserved.