org.silverpeas.admin.web
Class StructureElementEntity<T extends StructureElementEntity<T>>

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

All Implemented Interfaces:

Exposable, Serializable

Direct Known Subclasses:

ComponentEntity, SpaceEntity

public abstract class StructureElementEntity<T extends StructureElementEntity<T>>
extends AbstractTypeEntity

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

Constructor Summary

protected	StructureElementEntity()
protected	StructureElementEntity(String type, String id, String parentId, String label, String description, String status, int rank, boolean isInheritanceBlocked) Instantiating a new web entity from the corresponding data

Method Summary

boolean	equals(Object obj)
protected String	getDescription()
protected String	getId()
protected String	getLabel()
protected URI	getParentURI()
protected int	getRank()
protected String	getStatus()
protected abstract String	getStringBaseURI() Gets the URI base of the current entity
protected abstract String	getStringParentBaseURI() Gets the parent URI base of the current entity
URI	getURI() Gets the URI at which this resource is published and can be accessed.
URI	getUsersAndGroupsRolesURI()
int	hashCode()
protected boolean	isInheritanceBlocked()
T	withURI(URI uri) Sets a URI to this entity.

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

Constructor Detail

StructureElementEntity

protected StructureElementEntity(String type,
                                 String id,
                                 String parentId,
                                 String label,
                                 String description,
                                 String status,
                                 int rank,
                                 boolean isInheritanceBlocked)

Instantiating a new web entity from the corresponding data

StructureElementEntity

protected StructureElementEntity()

Method Detail

withURI

public T withURI(URI uri)

Sets a URI to this entity. With this URI, it can then be accessed through the Web.

Parameters:

uri - the web entity URI.

Returns:

itself.

getURI

public URI getURI()

Description copied from interface: Exposable

Gets the URI at which this resource is published and can be accessed.

Returns:

the web resource URI.

getParentURI

protected URI getParentURI()

getUsersAndGroupsRolesURI

public URI getUsersAndGroupsRolesURI()

getId

protected String getId()

getLabel

protected String getLabel()

getDescription

protected String getDescription()

getStatus

protected String getStatus()

getRank

protected int getRank()

isInheritanceBlocked

protected boolean isInheritanceBlocked()

getStringBaseURI

protected abstract String getStringBaseURI()

Gets the URI base of the current entity

Returns:

getStringParentBaseURI

protected abstract String getStringParentBaseURI()

Gets the parent URI base of the current entity

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object