Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.spaces.core.impl.docwrapper
Class DocSpaceImpl

java.lang.Object
  extended by org.nuxeo.ecm.spaces.core.impl.docwrapper.DocSpaceImpl
All Implemented Interfaces:
java.lang.Comparable<Space>, Space

public class DocSpaceImpl
extends java.lang.Object
implements Space


Field Summary
static java.lang.String TYPE
           
 
Method Summary
 int compareTo(Space o)
           
 Space copyFrom(Space space)
           
static DocSpaceImpl createFromSpace(Space o, java.lang.String path, CoreSession session)
           
 Gadget createGadget(java.lang.String gadgetName)
           
 Gadget createGadget(java.net.URL gadgetDefUrl)
           
 java.util.List<java.lang.String> getAvailableSecurityPermissions()
           
 java.lang.String getCategory()
          Family/category of this space
 java.lang.String getDescription()
          description of the space
 DocumentModel getDocument()
           
 Gadget getGadget(java.lang.String id)
           
 java.util.List<Gadget> getGadgets()
           
 java.lang.String getId()
          Unique identifier of a space instance
 java.lang.String getLayout()
          A key for displaying elements in this space
 java.lang.String getName()
          Name of the space
 java.lang.String getOwner()
          Name of the creator of this space
 java.util.Calendar getPublicationDate()
           
 java.lang.String getTheme()
          Space theme
 java.lang.String getTitle()
          Title of the space
 java.lang.String getViewer()
          Name of the viewer of this space
 boolean hasPermission(java.lang.String permissionName)
           
 boolean isEqualTo(Space space)
           
 boolean isReadOnly()
           
 void remove()
           
 void remove(Gadget gadget)
           
 void save()
           
 void save(Gadget gadget)
           
 void setCategory(java.lang.String category)
           
 void setDescription(java.lang.String description)
           
 void setLayout(java.lang.String name)
           
 void setPublicationDate(java.util.Calendar datePublication)
           
 void setTheme(java.lang.String theme)
           
 void setTitle(java.lang.String title)
           
 java.lang.Boolean validateGadgets(java.util.List<Gadget> gadgets)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values
Method Detail

getLayout

public java.lang.String getLayout()
                           throws ClientException
Description copied from interface: Space
A key for displaying elements in this space

Specified by:
getLayout in interface Space
Returns:
Throws:
ClientException

getCategory

public java.lang.String getCategory()
                             throws ClientException
Description copied from interface: Space
Family/category of this space

Specified by:
getCategory in interface Space
Returns:
Throws:
ClientException

isEqualTo

public boolean isEqualTo(Space space)

getTheme

public java.lang.String getTheme()
                          throws ClientException
Description copied from interface: Space
Space theme

Specified by:
getTheme in interface Space
Returns:
Throws:
ClientException

getDescription

public java.lang.String getDescription()
Description copied from interface: Space
description of the space

Specified by:
getDescription in interface Space
Returns:

getGadgets

public java.util.List<Gadget> getGadgets()
                                  throws ClientException
Specified by:
getGadgets in interface Space
Throws:
ClientException

getGadget

public Gadget getGadget(java.lang.String id)
                 throws ClientException
Specified by:
getGadget in interface Space
Throws:
ClientException

getId

public java.lang.String getId()
Description copied from interface: Space
Unique identifier of a space instance

Specified by:
getId in interface Space
Returns:

getName

public java.lang.String getName()
Description copied from interface: Space
Name of the space

Specified by:
getName in interface Space
Returns:

getOwner

public java.lang.String getOwner()
                          throws ClientException
Description copied from interface: Space
Name of the creator of this space

Specified by:
getOwner in interface Space
Returns:
Throws:
ClientException

getTitle

public java.lang.String getTitle()
                          throws ClientException
Description copied from interface: Space
Title of the space

Specified by:
getTitle in interface Space
Returns:
Throws:
ClientException

getViewer

public java.lang.String getViewer()
Description copied from interface: Space
Name of the viewer of this space

Specified by:
getViewer in interface Space
Returns:

hasPermission

public boolean hasPermission(java.lang.String permissionName)
                      throws ClientException
Specified by:
hasPermission in interface Space
Throws:
ClientException

getAvailableSecurityPermissions

public java.util.List<java.lang.String> getAvailableSecurityPermissions()
                                                                 throws ClientException
Throws:
ClientException

isReadOnly

public boolean isReadOnly()
                   throws ClientException
Specified by:
isReadOnly in interface Space
Throws:
ClientException

setLayout

public void setLayout(java.lang.String name)
               throws ClientException
Specified by:
setLayout in interface Space
Throws:
ClientException

save

public void save(Gadget gadget)
          throws ClientException
Specified by:
save in interface Space
Throws:
ClientException

createGadget

public Gadget createGadget(java.lang.String gadgetName)
                    throws ClientException
Specified by:
createGadget in interface Space
Throws:
ClientException

createGadget

public Gadget createGadget(java.net.URL gadgetDefUrl)
                    throws ClientException
Specified by:
createGadget in interface Space
Throws:
ClientException

getDocument

public DocumentModel getDocument()

createFromSpace

public static DocSpaceImpl createFromSpace(Space o,
                                           java.lang.String path,
                                           CoreSession session)
                                    throws ClientException
Throws:
ClientException

remove

public void remove(Gadget gadget)
            throws ClientException
Specified by:
remove in interface Space
Throws:
ClientException

save

public void save()
          throws ClientException
Specified by:
save in interface Space
Throws:
ClientException

copyFrom

public Space copyFrom(Space space)
               throws ClientException
Specified by:
copyFrom in interface Space
Throws:
ClientException

setDescription

public void setDescription(java.lang.String description)
                    throws ClientException
Specified by:
setDescription in interface Space
Throws:
ClientException

setTheme

public void setTheme(java.lang.String theme)
              throws ClientException
Specified by:
setTheme in interface Space
Throws:
ClientException

setTitle

public void setTitle(java.lang.String title)
              throws ClientException
Specified by:
setTitle in interface Space
Throws:
ClientException

setCategory

public void setCategory(java.lang.String category)
                 throws ClientException
Specified by:
setCategory in interface Space
Throws:
ClientException

getPublicationDate

public java.util.Calendar getPublicationDate()
                                      throws ClientException
Specified by:
getPublicationDate in interface Space
Throws:
ClientException

setPublicationDate

public void setPublicationDate(java.util.Calendar datePublication)
                        throws ClientException
Specified by:
setPublicationDate in interface Space
Throws:
ClientException

compareTo

public int compareTo(Space o)
Specified by:
compareTo in interface java.lang.Comparable<Space>

remove

public void remove()
            throws ClientException
Specified by:
remove in interface Space
Throws:
ClientException

validateGadgets

public java.lang.Boolean validateGadgets(java.util.List<Gadget> gadgets)
                                  throws ClientException
Specified by:
validateGadgets in interface Space
Throws:
ClientException

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.