com.atlassian.confluence.rest.client
Interface RemoteChildContentService.RemoteChildContentFinder

All Known Implementing Classes:
RemoteChildContentServiceImpl.RemoteChildContentFinderImpl
Enclosing interface:
RemoteChildContentService

public static interface RemoteChildContentService.RemoteChildContentFinder


Method Summary
 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 parent
 com.atlassian.util.concurrent.Promise<Map<ContentType,PageResponse<Content>>> fetchMappedByType(PageRequest request)
          Retrieve the content contained in this parent.
 RemoteChildContentService.RemoteChildContentFinder withDepth(Depth depth)
          Set the depth to retrieve content on the ChildContentFinder
 RemoteChildContentService.RemoteChildContentFinder withLocation(Collection<String> location)
          Set the location(s) to retrieve the content from
 RemoteChildContentService.RemoteChildContentFinder withParentVersion(int versionNumber)
          Specifies the which version of the parent content to use when looking for children.
 

Method Detail

fetchMappedByType

com.atlassian.util.concurrent.Promise<Map<ContentType,PageResponse<Content>>> fetchMappedByType(PageRequest request)
Retrieve the content contained in this parent.

The pageRequest limit is restricted to a maximum page size.

Returns:
a map of the content in this parent by contentType

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 parent

Parameters:
type - - the type of content to retrieve
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 parent

withDepth

RemoteChildContentService.RemoteChildContentFinder withDepth(Depth depth)
Set the depth to retrieve content on the ChildContentFinder

Parameters:
depth - - the depth in the page hierarchy of Content descendants to retrieve
Returns:
a child content finder with the depth parameter set

withParentVersion

RemoteChildContentService.RemoteChildContentFinder withParentVersion(int versionNumber)
Specifies the which version of the parent content to use when looking for children.

Parameters:
versionNumber - - the version of the parent content to use
Returns:
child content found under the particular version of parent content.
Throws:
BadRequestException - if the version is not valid

withLocation

RemoteChildContentService.RemoteChildContentFinder withLocation(Collection<String> location)
Set the location(s) to retrieve the content from

Parameters:
location -
Returns:
a child content finder with the location parameter set


Copyright © 2003–2015 Atlassian. All rights reserved.