OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidNode
Implementsosid.Identifiable
osid.Containable
Description

A node interface for hierarchical objects. The Id of the node is the Id of the object represented at this node.

MethodisRoot
Description

Tests if this node is a root in the hierarchy (has no parents). A node may have no more parents available in this node structure but is not a root in the hierarchy. If both isRoot() and hasParents() is false, the parents of this node may be accessed thorugh another node structure retrieval.

Returnboolean true if this node is a root in the hierarchy, false otherwise
CompliancemandatoryThis method must be implemented.
MethodhasParents
Description

Tests if any parents are available in this node structure. There may be no more parents in this node structure however there may be parents that exist in the hierarchy.

Returnboolean true if this node has parents, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParentIds
Description

Gets the parents of this node.

Returnosid.id.IdListthe parents of this node
CompliancemandatoryThis method must be implemented.
MethodisLeaf
Description

Tests if this node is a leaf in the hierarchy (has no children). A node may have no more children available in this node structure but is not a leaf in the hierarchy. If both isLeaf() and hasChildren() is false, the children of this node may be accessed thorugh another node structure retrieval.

Returnboolean true if this node is a leaf in the hierarchy, false otherwise
CompliancemandatoryThis method must be implemented.
MethodhasChildren
Description

Tests if any children are available in this node structure. There may be no more children available in this node structure but this node may have children in the hierarchy.

Returnboolean true if this node has children, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetChildIds
Description

Gets the children of this node.

Returnosid.id.IdListthe children of this node
CompliancemandatoryThis method must be implemented.