com.atlassian.confluence.api.impl.service.content

Class SpaceServiceImpl.SpaceContentImpl

java.lang.Object

com.atlassian.confluence.api.impl.service.content.SpaceServiceImpl.SpaceContentImpl

All Implemented Interfaces:

SpaceService.SpaceContentFinder

Enclosing class:

SpaceServiceImpl

public class SpaceServiceImpl.SpaceContentImpl
extends Object
implements SpaceService.SpaceContentFinder

Method Summary

Modifier and Type	Method and Description
PageResponse<Content>	fetchMany(ContentType type, PageRequest pageRequest) Retrieve all content contained in this space of the particular type
Map<ContentType,PageResponse<Content>>	fetchMappedByType(PageRequest pageRequest) 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

Methods inherited from class java.lang.Object

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

Method Detail

withDepth

public SpaceService.SpaceContentFinder withDepth(Depth depth)

Description copied from interface: SpaceService.SpaceContentFinder

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

Specified by:

withDepth in interface SpaceService.SpaceContentFinder

Parameters:

depth - - the depth to retrieve content at

Returns:

a page of content in this space at the given depth

fetchMappedByType

public Map<ContentType,PageResponse<Content>> fetchMappedByType(PageRequest pageRequest)
                                                         throws BadRequestException

Description copied from interface: SpaceService.SpaceContentFinder

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

Specified by:

fetchMappedByType in interface SpaceService.SpaceContentFinder

Returns:

a map of content in this space keyed by content type

Throws:

BadRequestException - if parameters to the finder are not recognized

fetchMany

public PageResponse<Content> fetchMany(ContentType type,
                                       PageRequest pageRequest)
                                throws BadRequestException

Description copied from interface: SpaceService.SpaceContentFinder

Retrieve all content contained in this space of the particular type

Specified by:

fetchMany in interface SpaceService.SpaceContentFinder

pageRequest - 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