com.atlassian.confluence.rest.client

Class AbstractRemoteChildContentService.AbstractRemoteChildContentFinder

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<ChildContentService.ChildContentFinder>

com.atlassian.confluence.rest.client.AbstractRemoteChildContentService.AbstractRemoteChildContentFinder

All Implemented Interfaces:

RemoteChildContentService.RemoteChildContentFinder

Direct Known Subclasses:

GraphQLRemoteChildContentServiceImpl.RemoteChildContentFinderImpl, RemoteChildContentServiceImpl.RemoteChildContentFinderImpl

Enclosing class:

AbstractRemoteChildContentService

protected abstract static class AbstractRemoteChildContentService.AbstractRemoteChildContentFinder
extends AbstractRemoteService<ChildContentService.ChildContentFinder>
implements RemoteChildContentService.RemoteChildContentFinder

Field Summary

Fields

Modifier and Type	Field and Description
protected Depth	depth
protected Collection<String>	location
protected int	parentVersion

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

provider

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRemoteChildContentFinder(AbstractRemoteService other)

Method Summary

Modifier and Type	Method and Description
abstract 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
abstract 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 parentVersion) Specifies the which version of the parent content to use when looking for children.

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

Field Detail

depth

protected Depth depth

parentVersion

protected int parentVersion

location

protected Collection<String> location

Constructor Detail

AbstractRemoteChildContentFinder

protected AbstractRemoteChildContentFinder(AbstractRemoteService other)

Method Detail

fetchMappedByType

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

Description copied from interface: RemoteChildContentService.RemoteChildContentFinder

Retrieve the content contained in this parent.

The pageRequest limit is restricted to a maximum page size.

Specified by:

fetchMappedByType in interface RemoteChildContentService.RemoteChildContentFinder

Returns:

a map of the content in this parent by contentType

fetchMany

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

Description copied from interface: RemoteChildContentService.RemoteChildContentFinder

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

Specified by:

fetchMany in interface RemoteChildContentService.RemoteChildContentFinder

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

public RemoteChildContentService.RemoteChildContentFinder withDepth(Depth depth)

Description copied from interface: RemoteChildContentService.RemoteChildContentFinder

Set the depth to retrieve content on the ChildContentFinder

Specified by:

withDepth in interface RemoteChildContentService.RemoteChildContentFinder

Parameters:

depth - - the depth in the page hierarchy of Content descendants to retrieve

Returns:

a child content finder with the depth parameter set

withParentVersion

public RemoteChildContentService.RemoteChildContentFinder withParentVersion(int parentVersion)

Description copied from interface: RemoteChildContentService.RemoteChildContentFinder

Specifies the which version of the parent content to use when looking for children.

Specified by:

withParentVersion in interface RemoteChildContentService.RemoteChildContentFinder

Parameters:

parentVersion - - the version of the parent content to use

Returns:

child content found under the particular version of parent content.

withLocation

public RemoteChildContentService.RemoteChildContentFinder withLocation(Collection<String> location)

Description copied from interface: RemoteChildContentService.RemoteChildContentFinder

Set the location(s) to retrieve the content from

Specified by:

withLocation in interface RemoteChildContentService.RemoteChildContentFinder

Returns:

a child content finder with the location parameter set