com.atlassian.confluence.api.service.content

Interface SpaceService.SpaceContentFinder

All Known Implementing Classes:

SpaceServiceImpl.SpaceContentImpl

Enclosing interface:

SpaceService

public static interface SpaceService.SpaceContentFinder

A finder interface to encapsulate finding content in a particular space

Method Summary

Modifier and Type	Method and Description
PageResponse<Content>	fetchMany(ContentType type, PageRequest request) Retrieve all content contained in this space of the particular type
Map<ContentType,PageResponse<Content>>	fetchMappedByType(PageRequest request) Retrieve all content contained in this space mapped by ContentType
SpaceService.SpaceContentFinder	withDepth(Depth depth) Applies a depth filter the content in this space retrieved by the finder, presently only pages participate in the space content hierarchy, the depth filter has no effect on other content type

Method Detail

withDepth

SpaceService.SpaceContentFinder withDepth(Depth depth)

Applies a depth filter the content in this space retrieved by the finder, presently only pages participate in the space content hierarchy, the depth filter has no effect on other content type

Parameters:

depth - - the depth to retrieve content at

Returns:

a page of content in this space at the given depth

Throws:

BadRequestException - if the requested depth is deeper than what can be provided

fetchMappedByType

Map<ContentType,PageResponse<Content>> fetchMappedByType(PageRequest request)
                                                  throws BadRequestException,
                                                         NotFoundException

Retrieve all content contained in this space mapped by ContentType

The pageRequest limit is restricted to a maximum page size, and applied to each value in the map

Returns:

a map of content in this space keyed by content type

Throws:

BadRequestException - if parameters to the finder are not recognized

NotFoundException - if the space does not exist

fetchMany

PageResponse<Content> fetchMany(ContentType type,
                                PageRequest request)
                         throws BadRequestException,
                                NotFoundException

Retrieve all content contained in this space of the particular type

Parameters:

request - the page request indicating the starting offset nd limit for the number of piece of content to return

Returns:

a partial list of all content in this space.

Throws:

BadRequestException - if parameters to the finder are not recognized

NotFoundException