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

Class SpaceServiceImpl.SpaceFinderImpl

java.lang.Object

com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder<Space>

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

All Implemented Interfaces:

SpaceService.SingleSpaceFetcher, SpaceService.SpaceFinder, ManyFetcher<Space>, SingleFetcher<Space>

Enclosing class:

SpaceServiceImpl

public class SpaceServiceImpl.SpaceFinderImpl
extends AbstractFinder<Space>
implements SpaceService.SpaceFinder

Field Summary

Fields inherited from class com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder

expansions

Method Summary

Modifier and Type	Method	Description
Optional<Space>	fetch()
PageResponse<Space>	fetchMany(PageRequest request)
SpaceService.SpaceFinder	withHasRetentionPolicy(boolean hasRetentionPolicy)	Filter spaces that have retention policies or not
SpaceService.SpaceFinder	withIsFavourited(boolean isFavourited)
SpaceService.SpaceFinder	withKeys(String... keys)
SpaceService.SpaceFinder	withLabels(Label... labels)
SpaceService.SpaceFinder	withStatus(SpaceStatus status)
SpaceService.SpaceFinder	withType(SpaceType type)

Methods inherited from class com.atlassian.confluence.api.impl.service.content.finder.AbstractFinder

getExpansions

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetchOne, fetchOneOrNull, fetchOrNull

Method Detail

withKeys

public SpaceService.SpaceFinder withKeys(String... keys)

Specified by:

withKeys in interface SpaceService.SpaceFinder

withType

public SpaceService.SpaceFinder withType(SpaceType type)

Specified by:

withType in interface SpaceService.SpaceFinder

withStatus

public SpaceService.SpaceFinder withStatus(SpaceStatus status)

Specified by:

withStatus in interface SpaceService.SpaceFinder

withLabels

public SpaceService.SpaceFinder withLabels(Label... labels)

Specified by:

withLabels in interface SpaceService.SpaceFinder

withIsFavourited

public SpaceService.SpaceFinder withIsFavourited(boolean isFavourited)

Specified by:

withIsFavourited in interface SpaceService.SpaceFinder

withHasRetentionPolicy

public SpaceService.SpaceFinder withHasRetentionPolicy(boolean hasRetentionPolicy)

Description copied from interface: SpaceService.SpaceFinder

Filter spaces that have retention policies or not

Specified by:

withHasRetentionPolicy in interface SpaceService.SpaceFinder

fetchMany

public PageResponse<Space> fetchMany(PageRequest request)

Specified by:

fetchMany in interface ManyFetcher<Space>

Parameters:

request - - a pageRequest to use to paginate the response, this will be limited if it exceeds system limits

Returns:

a pageResponse of given type that matches the given restrictions

fetch

public Optional<Space> fetch()

Specified by:

fetch in interface SingleFetcher<Space>