org.nuxeo.ecm.spaces.api
Interface SpaceManager

All Known Implementing Classes:

SpaceManagerImpl

public interface SpaceManager

Framework service for CRUD operations concerning Univers, Space in a specific univers, and Gadget in a specific space

Author:

10044893

Method Summary

java.lang.String	getProviderName(SpaceProvider provider)
Space	getSpace(java.lang.String name, CoreSession session)
Space	getSpace(java.lang.String name, SpaceProvider provider, CoreSession session) Deprecated.
Space	getSpace(java.lang.String name, Univers univers, CoreSession session) Retrieve a specific space from its name and its parent universe
Space	getSpaceFromId(java.lang.String spaceId, CoreSession session)
java.util.List<Space>	getSpacesForUnivers(Univers universe, CoreSession session) List of all accessible spaces for a given univers
java.util.List<SpaceProvider>	getSpacesProvider(Univers univers)
java.util.List<SpaceProvider>	getSpacesProviders()
Univers	getUnivers(java.lang.String name, CoreSession session) Retrieve a specific universe from its name
Univers	getUniversFromId(java.lang.String universId, CoreSession session)
java.util.List<Univers>	getUniversList(CoreSession session) List of all accessible universes

Method Detail

getUniversList

java.util.List<Univers> getUniversList(CoreSession session)
                                       throws SpaceException

List of all accessible universes

Returns:

the list of all accessible universes

Throws:

SpaceException - a bug has happened

getUnivers

Univers getUnivers(java.lang.String name,
                   CoreSession session)
                   throws UniversNotFoundException,
                          SpaceException

Retrieve a specific universe from its name

Parameters:

name - identifier of a univers

session - a core session

Returns:

a specific universe

Throws:

UniversNotFoundException - when no universe with such a name can be found

SpaceException - when a bug has happened

getUniversFromId

Univers getUniversFromId(java.lang.String universId,
                         CoreSession session)
                         throws SpaceException

Parameters:

universId -

Returns:

Throws:

UniversNotFoundException

SpaceException

getSpacesProvider

java.util.List<SpaceProvider> getSpacesProvider(Univers univers)

getSpacesForUnivers

java.util.List<Space> getSpacesForUnivers(Univers universe,
                                          CoreSession session)
                                          throws UniversNotFoundException,
                                                 SpaceException

List of all accessible spaces for a given univers

Parameters:

universe - the universe in which you are looking for spaces

Returns:

all accessible univers

Throws:

UniversNotFoundException - when no univers was found with the given universe id

SpaceException - when a bug has happened

getSpace

Space getSpace(java.lang.String name,
               Univers univers,
               CoreSession session)
               throws SpaceException

Retrieve a specific space from its name and its parent universe

Parameters:

name - name of the searched space

univers - parent container

Returns:

the space if found , else a SpaceException is thrown

Throws:

SpaceNotFoundException - when the space was not found

SpaceException

getSpace

Space getSpace(java.lang.String name,
               CoreSession session)
               throws SpaceException

Throws:

SpaceException

getSpace

@Deprecated
Space getSpace(java.lang.String name,
                          SpaceProvider provider,
                          CoreSession session)
               throws SpaceException

Deprecated.

Throws:

SpaceException

getSpaceFromId

Space getSpaceFromId(java.lang.String spaceId,
                     CoreSession session)
                     throws SpaceException

Throws:

SpaceException

getSpacesProviders

java.util.List<SpaceProvider> getSpacesProviders()

getProviderName

java.lang.String getProviderName(SpaceProvider provider)