Interface | osid.OsidNode | ||
---|---|---|---|
Implements | osid.Identifiable | ||
osid.Containable | |||
Description |
A node interface for hierarchical objects. The | ||
Method | isRoot | ||
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 | ||
Return | boolean | true if this node is a root in the hierarchy, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | hasParents | ||
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. | ||
Return | boolean | true if this node has parents, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getParentIds | ||
Description |
Gets the parents of this node. | ||
Return | osid.id.IdList | the parents of this node | |
Compliance | mandatory | This method must be implemented. | |
Method | isLeaf | ||
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 | ||
Return | boolean | true if this node is a leaf in the hierarchy, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | hasChildren | ||
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. | ||
Return | boolean | true if this node has children, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getChildIds | ||
Description |
Gets the children of this node. | ||
Return | osid.id.IdList | the children of this node | |
Compliance | mandatory | This method must be implemented. |