Package org.silverpeas.core.webapi.node

Class NodeEntity

java.lang.Object

org.silverpeas.core.webapi.node.NodeEntity

All Implemented Interfaces:

Serializable, WebEntity

public class NodeEntity
extends Object
implements WebEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NodeEntity()

Method Summary

Modifier and Type	Method	Description
static NodeEntity	fromNodeDetail(SilverpeasRole highestComponentUserRole, NodeDetail node, String uri)
static NodeEntity	fromNodeDetail(SilverpeasRole highestComponentUserRole, NodeDetail node, String uri, String lang)
static NodeEntity	fromNodeDetail(SilverpeasRole highestComponentUserRole, NodeDetail node, URI uri)	Creates a new node entity from the specified node.
static NodeEntity	fromNodeDetail(SilverpeasRole highestComponentUserRole, NodeDetail node, URI uri, String lang)
NodeAttrEntity	getAttr()
NodeEntity[]	getChildren()
URI	getChildrenURI()
URI	getChildrenURI(URI uri)
String	getId()
NodeStateEntity	getState()
String	getText()
NodeTranslationEntity[]	getTranslations()
NodeType	getType()
URI	getURI()	Gets the URI at which this web entity is published and can be accessed.
void	setAttr(NodeAttrEntity attr)
void	setChildren(NodeEntity[] children)
void	setChildrenURI(URI childrenURI)
void	setId(String id)
void	setState(NodeStateEntity state)
void	setText(String text)
void	setTranslations(NodeTranslationEntity[] translations)
void	setType(NodeType type)
void	setURI(URI uri)
NodePK	toNodePK()	Gets the node pk objet that this entity represents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NodeEntity

public NodeEntity()

Method Detail

fromNodeDetail

public static NodeEntity fromNodeDetail(SilverpeasRole highestComponentUserRole,
                                        NodeDetail node,
                                        URI uri)

Creates a new node entity from the specified node.

Parameters:

highestComponentUserRole - the highest component user role from which code are computed.

node - the node to entitify.

Returns:

the entity representing the specified node.

fromNodeDetail

public static NodeEntity fromNodeDetail(SilverpeasRole highestComponentUserRole,
                                        NodeDetail node,
                                        URI uri,
                                        String lang)

fromNodeDetail

public static NodeEntity fromNodeDetail(SilverpeasRole highestComponentUserRole,
                                        NodeDetail node,
                                        String uri)

fromNodeDetail

public static NodeEntity fromNodeDetail(SilverpeasRole highestComponentUserRole,
                                        NodeDetail node,
                                        String uri,
                                        String lang)

getURI

public URI getURI()

Description copied from interface: WebEntity

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

Specified by:

getURI in interface WebEntity

Returns:

the web entity URI.

setURI

public void setURI(URI uri)

setId

public void setId(String id)

getId

public String getId()

setChildren

public void setChildren(NodeEntity[] children)

getChildren

public NodeEntity[] getChildren()

setText

public final void setText(String text)

getText

public String getText()

getType

public NodeType getType()

setType

public final void setType(NodeType type)

setAttr

public final void setAttr(NodeAttrEntity attr)

getAttr

public NodeAttrEntity getAttr()

setState

public void setState(NodeStateEntity state)

getState

public NodeStateEntity getState()

setChildrenURI

public final void setChildrenURI(URI childrenURI)

getChildrenURI

public final URI getChildrenURI(URI uri)

getChildrenURI

public URI getChildrenURI()

setTranslations

public final void setTranslations(NodeTranslationEntity[] translations)

getTranslations

public NodeTranslationEntity[] getTranslations()

toNodePK

public NodePK toNodePK()

Gets the node pk objet that this entity represents.

Returns:

a node PK.