com.atlassian.confluence.spaces

Interface SpaceGroupManager

All Known Implementing Classes:

DefaultSpaceGroupManager

Deprecated.

in 5.9.

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

@Deprecated
public interface SpaceGroupManager

Method Summary

Modifier and Type	Method and Description
SpaceGroup	createSpaceGroup(String key, String name) Deprecated. Create a Space Group
SpaceGroup	createSpaceGroup(String key, String name, String creatorName) Deprecated. Create a space Group
SpaceGroup	getSpaceGroup(long id) Deprecated. Retrieve a space by its ID.
SpaceGroup	getSpaceGroup(String spaceGroupKey) Deprecated. Retrieve a spaceGroup by its key.
List	getSpaceGroups() Deprecated. Retrieves all SpaceGroups in the system
Set<SpaceGroup>	getSpaceGroupsForUser(String username) Deprecated.
void	removeSpaceGroup(SpaceGroup spaceGroup, boolean removeSpaces) Deprecated. Removes the spaceGroup without removing the space.
void	saveSpaceGroup(SpaceGroup spaceGroup) Deprecated.

Method Detail

createSpaceGroup

SpaceGroup createSpaceGroup(String key,
                            String name)

Deprecated.

Create a Space Group

createSpaceGroup

SpaceGroup createSpaceGroup(String key,
                            String name,
                            String creatorName)

Deprecated.

Create a space Group

saveSpaceGroup

void saveSpaceGroup(SpaceGroup spaceGroup)

Deprecated.

removeSpaceGroup

void removeSpaceGroup(SpaceGroup spaceGroup,
                      boolean removeSpaces)

Deprecated.

Removes the spaceGroup without removing the space. The contained spaces will be without a spaceGroup.

getSpaceGroup

SpaceGroup getSpaceGroup(long id)

Deprecated.

Retrieve a space by its ID. The space can be of any type.

Parameters:

id - the ID of the space

Returns:

the space, or null if no space exists with that id.

getSpaceGroup

SpaceGroup getSpaceGroup(String spaceGroupKey)

Deprecated.

Retrieve a spaceGroup by its key.

Parameters:

spaceGroupKey - the key of the spaceGroup to retrieve

Returns:

the spaceGroup, or null if no spaceGroup exists with that key

getSpaceGroups

List getSpaceGroups()

Deprecated.

Retrieves all SpaceGroups in the system

Returns:

List of SpaceGroup objects

getSpaceGroupsForUser

Set<SpaceGroup> getSpaceGroupsForUser(String username)

Deprecated.

Returns:

a set of space groups for the specified user, and empty set if none found.

Throws:

IllegalArgumentException - if username is null