org.sakaiproject.api.common.superstructure
Interface Node

All Superinterfaces:
Persistable, Typeable
All Known Implementing Classes:
NodeImpl

public interface Node
extends Persistable, Typeable

Since:
Sakai 2.0
Version:
$Id: Node.java 632 2005-07-14 21:22:50Z janderse@umich.edu $
Author:
Lance Speelmon

Method Summary
 void addChild(Node child)
          A convenience method which simplifies adding a child to a Node.
 Set getChildren()
          Provides direct access to the underlying Collection containing children.
 Integer getDepth()
          Returns the depth of the Node in the tree (0 based).
 String getDescription()
          Typically this value will contain more verbose text than the displayName.
 String getDisplayName()
           
 Node getParent()
           
 String getReferenceUuid()
          This is the pointer back to the referenced object.
 void removeChild(Node child)
          Removes a child Node from this Node.
 void setDescription(String description)
           
 void setDisplayName(String displayName)
           
 void setParent(Node parent)
           
 void setReferenceUuid(String referenceUuid)
          This is the pointer back to the referenced object.
 
Methods inherited from interface org.sakaiproject.api.common.manager.Persistable
getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid
 
Methods inherited from interface org.sakaiproject.api.common.type.Typeable
getType, setType
 

Method Detail

addChild

public void addChild(Node child)
A convenience method which simplifies adding a child to a Node.

Parameters:
child -

removeChild

public void removeChild(Node child)
Removes a child Node from this Node.

Parameters:
child -

getChildren

public Set getChildren()
Provides direct access to the underlying Collection containing children. Mutations of this Set will not be persisted unless you save the Node through the Manager.

Returns:
Returns the children.

getDescription

public String getDescription()
Typically this value will contain more verbose text than the displayName.

Returns:
Returns the description.

setDescription

public void setDescription(String description)
Parameters:
description - The description to set (i.e. the "long" name).

getDisplayName

public String getDisplayName()
Returns:
The "short" name of the Node.

setDisplayName

public void setDisplayName(String displayName)
Parameters:
displayName - The "short" name of the Node.

getParent

public Node getParent()
Returns:
Returns the parent of the Node.

setParent

public void setParent(Node parent)

getReferenceUuid

public String getReferenceUuid()
This is the pointer back to the referenced object.

Returns:

setReferenceUuid

public void setReferenceUuid(String referenceUuid)
This is the pointer back to the referenced object.

Parameters:
referenceUuid -

getDepth

public Integer getDepth()
Returns the depth of the Node in the tree (0 based).

Returns: