org.silverpeas.admin.web
Class SpaceEntity

java.lang.Object
  extended by org.silverpeas.admin.web.AbstractTypeEntity
      extended by org.silverpeas.admin.web.StructureElementEntity<SpaceEntity>
          extended by org.silverpeas.admin.web.SpaceEntity
All Implemented Interfaces:
Exposable, Serializable

public class SpaceEntity
extends StructureElementEntity<SpaceEntity>

The space instance light entity is a SpaceInstLight object that is exposed in the web as an entity (web entity). As such, it publishes only some of its attributes. It represents a SpaceInstLight in Silverpeas plus some additional information such as the URI for accessing it.

Author:
Yohann Chastagnier
See Also:
Serialized Form

Field Summary
static String TYPE
           
 
Constructor Summary
protected SpaceEntity()
           
 
Method Summary
 SpaceEntity addUserFavorites(String favorite)
           
static SpaceEntity createFrom(SpaceInstLight space, String language)
          Creates a new SpaceInstLight entity from the specified SpaceInstLight.
 URI getAppearanceURI()
          Gets the URI of the appearance of the space.
 URI getComponentsURI()
          Gets the URI of components included in the space.
 URI getContentURI()
          Gets the URI of the content included in the space.
protected  String getFavorite()
          Gets the favorite data of the space
 int getLevel()
          Gets the level of the space.
 URI getSpacesURI()
          Gets the URI of spaces included in the space.
protected  String getStringBaseURI()
          Gets the URI base of the current entity
protected  String getStringParentBaseURI()
          Gets the parent URI base of the current entity
 boolean isSpaceDisplayedAtFirst()
          Indicates if spaces have to be displayed before or not the applications.
 SpaceEntity withURI(URI uri)
          Sets a URI to this entity.
 
Methods inherited from class org.silverpeas.admin.web.StructureElementEntity
equals, getDescription, getId, getLabel, getParentURI, getRank, getStatus, getURI, getUsersAndGroupsRolesURI, hashCode, isInheritanceBlocked
 
Methods inherited from class org.silverpeas.admin.web.AbstractTypeEntity
getType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE

public static final String TYPE
See Also:
Constant Field Values
Constructor Detail

SpaceEntity

protected SpaceEntity()
Method Detail

createFrom

public static SpaceEntity createFrom(SpaceInstLight space,
                                     String language)
Creates a new SpaceInstLight entity from the specified SpaceInstLight.

Parameters:
space - the SpaceInstLight to entitify.
language - the current language.
Returns:
the entity representing the specified SpaceInstLight.

withURI

public SpaceEntity withURI(URI uri)
Description copied from class: StructureElementEntity
Sets a URI to this entity. With this URI, it can then be accessed through the Web.

Overrides:
withURI in class StructureElementEntity<SpaceEntity>
Parameters:
uri - the web entity URI.
Returns:
itself.

addUserFavorites

public SpaceEntity addUserFavorites(String favorite)

getLevel

public int getLevel()
Gets the level of the space.

Returns:
the level of the space

getSpacesURI

public URI getSpacesURI()
Gets the URI of spaces included in the space.

Returns:
the URI of spaces included in the space

getComponentsURI

public URI getComponentsURI()
Gets the URI of components included in the space.

Returns:
the URI of component included in the space

getContentURI

public URI getContentURI()
Gets the URI of the content included in the space.

Returns:
the URI of the content included in the space

getAppearanceURI

public URI getAppearanceURI()
Gets the URI of the appearance of the space.

Returns:
the URI of the appearance of the space

isSpaceDisplayedAtFirst

public boolean isSpaceDisplayedAtFirst()
Indicates if spaces have to be displayed before or not the applications.

Returns:
true or false

getFavorite

protected final String getFavorite()
Gets the favorite data of the space

Returns:
the favorite data

getStringBaseURI

protected String getStringBaseURI()
Gets the URI base of the current entity

Specified by:
getStringBaseURI in class StructureElementEntity<SpaceEntity>
Returns:

getStringParentBaseURI

protected String getStringParentBaseURI()
Description copied from class: StructureElementEntity
Gets the parent URI base of the current entity

Specified by:
getStringParentBaseURI in class StructureElementEntity<SpaceEntity>
Returns:


Copyright © 2016 Silverpeas. All Rights Reserved.