org.nuxeo.ecm.spaces.api
Interface SpaceProvider

All Known Implementing Classes:

AbstractSpaceProvider, DashboardSpaceProvider, RootDocSpaceProvider, SingleDocSpaceProvider

public interface SpaceProvider

Method Summary

void	add(Space o, CoreSession session)
void	addAll(java.util.Collection<? extends Space> c, CoreSession session)
void	clear(CoreSession session)
java.util.List<Space>	getAll(CoreSession session)
java.util.List<Space>	getAllSpaces(CoreSession session) Gets all Spaces supplied by SpaceProvider.
java.lang.String	getName() Gets SpaceProvider's name.
Space	getSpace(java.lang.String spaceName, CoreSession session)
void	initialize(java.util.Map<java.lang.String,java.lang.String> params)
boolean	isEmpty(CoreSession session)
boolean	isReadOnly(CoreSession session)
boolean	remove(Space space, CoreSession session)
long	size(CoreSession session)

Method Detail

initialize

void initialize(java.util.Map<java.lang.String,java.lang.String> params)
                throws java.lang.Exception

Throws:

java.lang.Exception

getSpace

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

Throws:

SpaceException

getAll

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

Throws:

SpaceException

add

void add(Space o,
         CoreSession session)
         throws SpaceException

Throws:

SpaceException

addAll

void addAll(java.util.Collection<? extends Space> c,
            CoreSession session)
            throws SpaceException

Throws:

SpaceException

clear

void clear(CoreSession session)
           throws SpaceException

Throws:

SpaceException

isEmpty

boolean isEmpty(CoreSession session)
                throws SpaceException

Throws:

SpaceException

remove

boolean remove(Space space,
               CoreSession session)
               throws SpaceException

Throws:

SpaceException

size

long size(CoreSession session)
          throws SpaceException

Throws:

SpaceException

isReadOnly

boolean isReadOnly(CoreSession session)

getName

java.lang.String getName()
                         throws SpaceException

Gets SpaceProvider's name.

Returns:

provider name

Throws:

SpaceException - if space manager is not reachable

getAllSpaces

java.util.List<Space> getAllSpaces(CoreSession session)

Gets all Spaces supplied by SpaceProvider. This method does not throw any exception, it can be useful in some cases.

Parameters:

session - core session

Returns:

list of Space OR an empty list if no spaces are supplied by space provider (never returns null)