com.atlassian.confluence.rest.client

Class RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<SpaceService.SpaceContentFinder>

com.atlassian.confluence.rest.client.RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl

All Implemented Interfaces:

RemoteSpaceService.RemoteSpaceContentFinder

Enclosing class:

RemoteSpaceServiceImpl

public class RemoteSpaceServiceImpl.RemoteSpaceContentFinderImpl
extends AbstractRemoteService<SpaceService.SpaceContentFinder>
implements RemoteSpaceService.RemoteSpaceContentFinder

Constructor Summary

Constructors

Constructor and Description
RemoteSpaceContentFinderImpl(AbstractRemoteService other, Space space, Expansion[] expansion)

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

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteSpaceContentFinderImpl

public RemoteSpaceContentFinderImpl(AbstractRemoteService other,
                                    Space space,
                                    Expansion[] expansion)

Method Detail

fetchMappedByType

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

Description copied from interface: RemoteSpaceService.RemoteSpaceContentFinder

Retrieve the all content contained in this space.

The pageRequest limit is restricted to a maximum page size.

Specified by:

fetchMappedByType in interface RemoteSpaceService.RemoteSpaceContentFinder

Returns:

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

fetchMany

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

Description copied from interface: RemoteSpaceService.RemoteSpaceContentFinder

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

Specified by:

fetchMany in interface RemoteSpaceService.RemoteSpaceContentFinder

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

public RemoteSpaceService.RemoteSpaceContentFinder withDepth(Depth depth)

Description copied from interface: RemoteSpaceService.RemoteSpaceContentFinder

Set the depth to retrieve content on the SpaceContentFinder

Specified by:

withDepth in interface RemoteSpaceService.RemoteSpaceContentFinder

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