ComponentEntity (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.webapi.admin.AbstractTypeEntity
- - org.silverpeas.core.webapi.admin.StructureElementEntity<ComponentEntity>
  - - org.silverpeas.core.webapi.admin.ComponentEntity

All Implemented Interfaces:

Serializable, WebEntity
```
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

Fields
Modifier and Type Field Description

static String TYPE

Constructor Summary

Constructors
Modifier Constructor Description

protected ComponentEntity()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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()`
`protected String`	`getStringParentBaseURI()`
`String`	`getUrl()`	Gets the url of the component.

Methods inherited from class org.silverpeas.core.webapi.admin.StructureElementEntity
equals, getDescription, getId, getLabel, getParentURI, getRank, getStatus, getURI, getUsersAndGroupsRolesURI, hashCode, isInheritanceBlocked, withURI

Methods inherited from class org.silverpeas.core.webapi.admin.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()
```
    Specified by:
    
    getStringBaseURI in class StructureElementEntity<ComponentEntity>
    
    Returns:
    
    the URI base of the current entity
  - getStringParentBaseURI
```
protected String getStringParentBaseURI()
```
    Specified by:
    
    getStringParentBaseURI in class StructureElementEntity<ComponentEntity>
    
    Returns:
    
    the parent URI base of the current entity