Package com.atlassian.confluence.spaces

Class SpacesQuery.Builder

java.lang.Object

com.atlassian.confluence.spaces.SpacesQuery.Builder

Enclosing class:

SpacesQuery

public static class SpacesQuery.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
SpacesQuery	build()
SpacesQuery.Builder	createdAfter(Date date)
SpacesQuery.Builder	forUser(ConfluenceUser user)
SpacesQuery.Builder	forUser(com.atlassian.user.User user)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.5 use forUser(ConfluenceUser)
SpacesQuery.Builder	inGroup(com.atlassian.user.Group group)	Deprecated. in 5.9 Permissions are checked based on all groups the user is a member of (if a user is specified), which is determined in the implementation, so this is effectively ignored (and has been for a long time).
SpacesQuery.Builder	inGroups(List<com.atlassian.user.Group> groups)	Deprecated. in 5.9 Permissions are checked based on all groups the user is a member of (if a user is specified), which is determined in the implementation, so this is effectively ignored (and has been for a long time).
SpacesQuery.Builder	inSpaceGroup(SpaceGroup spaceGroup)	Deprecated. in 5.9.
SpacesQuery.Builder	sortBy(String sortColumn)
SpacesQuery.Builder	unsorted()
SpacesQuery.Builder	withContentContainingLabels(Iterable<Label> labels)
SpacesQuery.Builder	withHasRetentionPolicy(boolean hasRetentionPolicy)
SpacesQuery.Builder	withIsFavourited(boolean isFavourited)
SpacesQuery.Builder	withLabel(Label label)
SpacesQuery.Builder	withLabels(Iterable<Label> labels)
SpacesQuery.Builder	withPermission(String permission)
SpacesQuery.Builder	withSpaceIds(Set<Long> spaceIds)
SpacesQuery.Builder	withSpaceKey(String spaceKey)
SpacesQuery.Builder	withSpaceKeys(Iterable<String> spaceKeys)
SpacesQuery.Builder	withSpaceStatus(SpaceStatus status)
SpacesQuery.Builder	withSpaceType(SpaceType type)

Methods inherited from class java.lang.Object

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

Method Details

withSpaceKey

public SpacesQuery.Builder withSpaceKey(String spaceKey)

withSpaceKeys

public SpacesQuery.Builder withSpaceKeys(Iterable<String> spaceKeys)

withSpaceType

public SpacesQuery.Builder withSpaceType(SpaceType type)

withLabel

public SpacesQuery.Builder withLabel(Label label)

withLabels

public SpacesQuery.Builder withLabels(Iterable<Label> labels)

withContentContainingLabels

public SpacesQuery.Builder withContentContainingLabels(Iterable<Label> labels)

withIsFavourited

public SpacesQuery.Builder withIsFavourited(boolean isFavourited)

withHasRetentionPolicy

public SpacesQuery.Builder withHasRetentionPolicy(boolean hasRetentionPolicy)

forUser

public SpacesQuery.Builder forUser(ConfluenceUser user)

Since:

9.5

forUser

@Deprecated(forRemoval=true,
            since="9.5")
public SpacesQuery.Builder forUser(com.atlassian.user.User user)

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.5 use forUser(ConfluenceUser)

withSpaceIds

public SpacesQuery.Builder withSpaceIds(Set<Long> spaceIds)

inGroup

@Deprecated
public SpacesQuery.Builder inGroup(com.atlassian.user.Group group)

Deprecated.

in 5.9 Permissions are checked based on all groups the user is a member of (if a user is specified), which is determined in the implementation, so this is effectively ignored (and has been for a long time).

inGroups

@Deprecated
public SpacesQuery.Builder inGroups(List<com.atlassian.user.Group> groups)

Deprecated.

in 5.9 Permissions are checked based on all groups the user is a member of (if a user is specified), which is determined in the implementation, so this is effectively ignored (and has been for a long time).

withPermission

public SpacesQuery.Builder withPermission(String permission)

inSpaceGroup

@Deprecated
public SpacesQuery.Builder inSpaceGroup(SpaceGroup spaceGroup)

Deprecated.

in 5.9.

SpaceGroup and related classes like SpaceGroupManager and SpaceGroupComparator will be removed. Please do not use them.

sortBy

public SpacesQuery.Builder sortBy(String sortColumn)

unsorted

public SpacesQuery.Builder unsorted()

createdAfter

public SpacesQuery.Builder createdAfter(Date date)

withSpaceStatus

public SpacesQuery.Builder withSpaceStatus(SpaceStatus status)

build

public SpacesQuery build()