org.silverpeas.admin.web
Class ComponentEntity

java.lang.Object
  org.silverpeas.admin.web.AbstractTypeEntity
      org.silverpeas.admin.web.StructureElementEntity<ComponentEntity>
          org.silverpeas.admin.web.ComponentEntity

All Implemented Interfaces:

Exposable, Serializable

public class ComponentEntity
extends StructureElementEntity<ComponentEntity>

The component instance light entity is a ComponentInstLight object that is exposed in the web as an entity (web entity). As such, it publishes only some of its attributes. It represents a ComponentInstLight 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

ComponentEntity()

Method Summary

static ComponentEntity	createFrom(ComponentInstLight component, String language) Creates a new ComponentInstLight entity from the specified ComponentInstLight.
String	getName() Gets the name of the component.
protected String	getStringBaseURI() Gets the URI base of the current entity
protected String	getStringParentBaseURI() Gets the parent URI base of the current entity
String	getUrl() Gets the url of the component.

Methods inherited from class org.silverpeas.admin.web.StructureElementEntity

equals, getDescription, getId, getLabel, getParentURI, getRank, getStatus, getURI, getUsersAndGroupsRolesURI, hashCode, isInheritanceBlocked, withURI

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

ComponentEntity

protected ComponentEntity()

Method Detail

createFrom

public static ComponentEntity createFrom(ComponentInstLight component,
                                         String language)

Creates a new ComponentInstLight entity from the specified ComponentInstLight.

Parameters:

component - the ComponentInstLight to entitify.

language - the current language.

Returns:

the entity representing the specified ComponentInstLight.

getName

public String getName()

Gets the name of the component.

Returns:

the name of the component.

getUrl

public String getUrl()

Gets the url of the component.

Returns:

the url of the component.

getStringBaseURI

protected String getStringBaseURI()

Description copied from class: StructureElementEntity

Gets the URI base of the current entity

Specified by:

getStringBaseURI in class StructureElementEntity<ComponentEntity>

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<ComponentEntity>

Returns: