org.nuxeo.ecm.spaces.api

Interface SpaceProvider

All Known Implementing Classes:

AbstractSpaceProvider, AnonymousDashboardSpaceProvider, CollaborationDashboardSpaceProvider, DefaultDashboardSpaceProvider, SocialWorkspaceDefaultSpaceProvider, SocialWorkspacePrivateSpaceProvider, SocialWorkspacePublicSpaceProvider, UserDashboardSpaceProvider

public interface SpaceProvider

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)
void	initialize(String name, Map<String,String> params)
boolean	isEmpty(CoreSession session, DocumentModel contextDocument)
boolean	isReadOnly(CoreSession session)
boolean	remove(Space space, CoreSession session)
long	size(CoreSession session, DocumentModel contextDocument)

Method Detail

initialize

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

Throws:

SpaceException

getName

String getName()

Gets SpaceProvider's name.

Returns:

provider name

getSpace

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

Throws:

SpaceException

getSpace

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

Throws:

SpaceException

getAll

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

Throws:

SpaceException

size

long size(CoreSession session,
        DocumentModel contextDocument)
          throws SpaceException

Throws:

SpaceException

isEmpty

boolean isEmpty(CoreSession session,
              DocumentModel contextDocument)
                throws SpaceException

Throws:

SpaceException

isReadOnly

boolean isReadOnly(CoreSession session)

add

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

Throws:

SpaceException

addAll

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

Throws:

SpaceException

remove

boolean remove(Space space,
             CoreSession session)
               throws SpaceException

Throws:

SpaceException

clear

void clear(CoreSession session)
           throws SpaceException

Throws:

SpaceException