org.nuxeo.ecm.spaces.api

Class AbstractSpaceProvider

java.lang.Object

org.nuxeo.ecm.spaces.api.AbstractSpaceProvider

All Implemented Interfaces:

SpaceProvider

Direct Known Subclasses:

AnonymousDashboardSpaceProvider, CollaborationDashboardSpaceProvider, DefaultDashboardSpaceProvider, SocialWorkspacePrivateSpaceProvider, SocialWorkspacePublicSpaceProvider, UserDashboardSpaceProvider

public abstract class AbstractSpaceProvider
extends Object
implements SpaceProvider

Constructor Summary

Constructors

Constructor and Description
AbstractSpaceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Space o, CoreSession session, Map<String,String> params)
void	addAll(Collection<? extends Space> c, CoreSession session)
void	clear(CoreSession session)
List<Space>	getAll(CoreSession session, DocumentModel contextDocument)
String	getName() Gets SpaceProvider's name.
Space	getSpace(CoreSession session, DocumentModel contextDocument, String spaceName)
Space	getSpace(CoreSession session, DocumentModel contextDocument, String spaceName, Map<String,String> parameters)
List<Space>	getSpaces(Space space, CoreSession session)
void	initialize(String name, Map<String,String> params)
boolean	isEmpty(CoreSession session, DocumentModel contextDocument)
boolean	remove(Space space, CoreSession session)
long	size(CoreSession session, DocumentModel contextDocument)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.spaces.api.SpaceProvider

isReadOnly

Constructor Detail

AbstractSpaceProvider

public AbstractSpaceProvider()

Method Detail

initialize

public void initialize(String name,
              Map<String,String> params)
                throws SpaceException

Specified by:

initialize in interface SpaceProvider

Throws:

SpaceException

getName

public final String getName()

Description copied from interface: SpaceProvider

Gets SpaceProvider's name.

Specified by:

getName in interface SpaceProvider

Returns:

provider name

getSpace

public final Space getSpace(CoreSession session,
             DocumentModel contextDocument,
             String spaceName,
             Map<String,String> parameters)
                     throws SpaceException

Specified by:

getSpace in interface SpaceProvider

Throws:

SpaceException

getSpace

public final Space getSpace(CoreSession session,
             DocumentModel contextDocument,
             String spaceName)
                     throws SpaceException

Specified by:

getSpace in interface SpaceProvider

Throws:

SpaceException

getAll

public List<Space> getAll(CoreSession session,
                 DocumentModel contextDocument)
                   throws SpaceException

Specified by:

getAll in interface SpaceProvider

Throws:

SpaceException

isEmpty

public boolean isEmpty(CoreSession session,
              DocumentModel contextDocument)
                throws SpaceException

Specified by:

isEmpty in interface SpaceProvider

Throws:

SpaceException

size

public long size(CoreSession session,
        DocumentModel contextDocument)
          throws SpaceException

Specified by:

size in interface SpaceProvider

Throws:

SpaceException

add

public void add(Space o,
       CoreSession session,
       Map<String,String> params)
         throws SpaceException

Specified by:

add in interface SpaceProvider

Throws:

SpaceException

addAll

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

Specified by:

addAll in interface SpaceProvider

Throws:

SpaceException

remove

public boolean remove(Space space,
             CoreSession session)
               throws SpaceException

Specified by:

remove in interface SpaceProvider

Throws:

SpaceException

clear

public void clear(CoreSession session)
           throws SpaceException

Specified by:

clear in interface SpaceProvider

Throws:

SpaceException

getSpaces

public List<Space> getSpaces(Space space,
                    CoreSession session)