com.atlassian.confluence.rest.client

Interface RemoteSpaceService.RemoteSpaceContentFinder

All Known Implementing Classes:

RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl

Enclosing interface:

RemoteSpaceService

public static interface RemoteSpaceService.RemoteSpaceContentFinder

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<PageResponse<Content>>	fetchMany(ContentType type, PageRequest request) Retrieve a paged list of content of the given type contained in this space
com.atlassian.util.concurrent.Promise<Map<ContentType,PageResponse<Content>>>	fetchMappedByType(PageRequest request) Retrieve the all content contained in this space.
RemoteSpaceService.RemoteSpaceContentFinder	withDepth(Depth depth) Set the depth to retrieve content on the SpaceContentFinder

Method Detail

fetchMappedByType

com.atlassian.util.concurrent.Promise<Map<ContentType,PageResponse<Content>>> fetchMappedByType(PageRequest request)

Retrieve the all content contained in this space.

The pageRequest limit is restricted to a maximum page size.

Returns:

a map of the content in this space by contentType, eith Page or BlogPost

fetchMany

com.atlassian.util.concurrent.Promise<PageResponse<Content>> fetchMany(ContentType type,
                                                                       PageRequest request)

Retrieve a paged list of content of the given type contained in this space

Parameters:

type - - the type of content to retrieve, either ContentType.Page or ContentType.BlogPost

request - - a page request indicating the start and limit of items to return

Returns:

a paged list of content of the given type contained in this space

withDepth

RemoteSpaceService.RemoteSpaceContentFinder withDepth(Depth depth)

Set the depth to retrieve content on the SpaceContentFinder

Parameters:

depth - - the depth in the page heirarchy of Content decendents to retrieve, a depth of 0 returns top level content in the space

Returns:

a space content finder with the depth parameter set