Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.spaces.api
Interface Space

All Superinterfaces:
Comparable<Space>
All Known Implementing Classes:
DocSpaceImpl

public interface Space
extends Comparable<Space>


Method Summary
 Space copyFrom(Space space)
           
 Gadget createGadget(String gadgetName)
           
 Gadget createGadget(URL gadgetDefUrl)
           
 String getCategory()
          Family/category of this space
 String getDescription()
          description of the space
 Gadget getGadget(String id)
           
 List<Gadget> getGadgets()
           
 String getId()
          Unique identifier of a space instance
 String getLayout()
          A key for displaying elements in this space
 String getName()
          Name of the space
 String getOwner()
          Name of the creator of this space
 Calendar getPublicationDate()
           
 String getTheme()
          Space theme
 String getTitle()
          Title of the space
 String getViewer()
          Name of the viewer of this space
 boolean hasPermission(String permissionName)
           
 boolean isReadOnly()
           
 void remove()
           
 void remove(Gadget gadget)
           
 void save()
           
 void save(Gadget gadget)
           
 void setCategory(String category)
           
 void setDescription(String description)
           
 void setLayout(String name)
           
 void setPublicationDate(Calendar datePublication)
           
 void setTheme(String theme)
           
 void setTitle(String title)
           
 Boolean validateGadgets(List<Gadget> gadgets)
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

String getId()
Unique identifier of a space instance

Returns:

getName

String getName()
Name of the space

Returns:

getTheme

String getTheme()
                throws ClientException
Space theme

Returns:
Throws:
ClientException

setTheme

void setTheme(String theme)
              throws ClientException
Throws:
ClientException

getTitle

String getTitle()
                throws ClientException
Title of the space

Returns:
Throws:
ClientException

setTitle

void setTitle(String title)
              throws ClientException
Throws:
ClientException

getDescription

String getDescription()
                      throws ClientException
description of the space

Returns:
Throws:
ClientException

setDescription

void setDescription(String description)
                    throws ClientException
Throws:
ClientException

getLayout

String getLayout()
                 throws ClientException
A key for displaying elements in this space

Returns:
Throws:
ClientException

setLayout

void setLayout(String name)
               throws ClientException
Throws:
ClientException

getCategory

String getCategory()
                   throws ClientException
Family/category of this space

Returns:
Throws:
ClientException

setCategory

void setCategory(String category)
                 throws ClientException
Throws:
ClientException

getOwner

String getOwner()
                throws ClientException
Name of the creator of this space

Returns:
Throws:
ClientException

getViewer

String getViewer()
                 throws ClientException
Name of the viewer of this space

Returns:
Throws:
ClientException

isReadOnly

boolean isReadOnly()
                   throws ClientException
Throws:
ClientException

createGadget

Gadget createGadget(String gadgetName)
                    throws ClientException
Throws:
ClientException

createGadget

Gadget createGadget(URL gadgetDefUrl)
                    throws ClientException
Throws:
ClientException

save

void save(Gadget gadget)
          throws ClientException
Throws:
ClientException

remove

void remove(Gadget gadget)
            throws ClientException
Throws:
ClientException

getGadgets

List<Gadget> getGadgets()
                        throws ClientException
Throws:
ClientException

getGadget

Gadget getGadget(String id)
                 throws ClientException
Throws:
ClientException

hasPermission

boolean hasPermission(String permissionName)
                      throws ClientException
Throws:
ClientException

save

void save()
          throws ClientException
Throws:
ClientException

remove

void remove()
            throws ClientException
Throws:
ClientException

copyFrom

Space copyFrom(Space space)
               throws ClientException
Throws:
ClientException

getPublicationDate

Calendar getPublicationDate()
                            throws ClientException
Throws:
ClientException

setPublicationDate

void setPublicationDate(Calendar datePublication)
                        throws ClientException
Throws:
ClientException

validateGadgets

Boolean validateGadgets(List<Gadget> gadgets)
                        throws ClientException
Throws:
ClientException

Nuxeo Enterprise Platform 5.4

Copyright © 2011 Nuxeo SAS. All Rights Reserved.