com.atlassian.confluence.api.service.content

Interface ChildContentService.ChildContentFinder

Enclosing interface:

ChildContentService

public static interface ChildContentService.ChildContentFinder

A finder interface to encapsulate finding content under a particular parent

Method Summary

Modifier and Type	Method and Description
PageResponse<Content>	fetchMany(ContentType type, PageRequest request) Retrieve all content of the particular type contained in this parent.
Map<ContentType,PageResponse<Content>>	fetchMappedByType(PageRequest request) Retrieve all content contained in this parent mapped by ContentType.
ChildContentService.ChildContentFinder	withDepth(Depth depth) Applies a depth filter to the content found under this parent and retrieved by the finder.
ChildContentService.ChildContentFinder	withLocation(Collection<String> location) Apply a content filter to the content found under this parent and retrieved by the finder.
ChildContentService.ChildContentFinder	withParentVersion(int versionNumber) Specifies the which version of the parent content to use when looking for children.

Method Detail

withDepth

ChildContentService.ChildContentFinder withDepth(Depth depth)

Applies a depth filter to the content found under this parent and retrieved by the finder.

Presently only pages participate in the child content hierarchy, the depth filter has no effect on other content types.

Parameters:

depth - - the depth to retrieve content at

Returns:

a page of content under this parent at the given depth

Throws:

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

withParentVersion

ChildContentService.ChildContentFinder 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

fetchMappedByType

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

Retrieve all content contained in this parent 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 under this parent keyed by content type

Throws:

BadRequestException - if parameters to the finder are not recognized

fetchMany

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

Retrieve all content of the particular type contained in this parent.

Parameters:

request - the page request indicating the starting offset and limit for the number of pieces of content to return

Returns:

a partial list of all content in this space.

Throws:

BadRequestException - if parameters to the finder are not recognized

withLocation

ChildContentService.ChildContentFinder withLocation(Collection<String> location)

Apply a content filter to the content found under this parent and retrieved by the finder.

Parameters:

location - for filtering the content by a collection of string value. Possible values are: "", "footer", "inline" and "resolved"

Returns:

the ChildContentFinder object

Since:

5.7