org.nuxeo.ecm.spaces.api
Interface Univers

All Known Implementing Classes:

AbstractUnivers, DocUniversImpl, VirtualUnivers

public interface Univers

Global container corresponding to a site . A univers can contain Space elements . Space elements contained in this universe are retrieved via the SpaceManager framework service :

SpaceManager service = Framework.getService(SpaceManager.class)
List<Space> spaces = service.getSpacesForUnivers(univers,coreSession);

Method Summary

java.lang.String	getDescription() Universe description.
java.lang.String	getId() UID.
java.lang.String	getName() Universe name.
java.util.List<SpaceProvider>	getSpaceProviders(CoreSession session)
java.util.List<Space>	getSpaces(CoreSession session)
java.lang.String	getTitle() Universe title.
boolean	isEqualTo(Univers univers) For comparison.

Method Detail

getId

java.lang.String getId()

UID.

Returns:

a unique identifier for a given instance of Univers implementation

getName

java.lang.String getName()

Universe name.

Returns:

the name of this universe

getTitle

java.lang.String getTitle()

Universe title.

Returns:

the title of this universe

getDescription

java.lang.String getDescription()

Universe description.

Returns:

the description of this universe

isEqualTo

boolean isEqualTo(Univers univers)

For comparison.

getSpaces

java.util.List<Space> getSpaces(CoreSession session)
                                throws SpaceException

Throws:

SpaceException

getSpaceProviders

java.util.List<SpaceProvider> getSpaceProviders(CoreSession session)
                                                throws SpaceException

Parameters:

session -

Returns:

list of SpaceProvider

Throws:

SpaceException