org.osid.cataloging

Interface CatalogNode

All Superinterfaces:

Containable, Identifiable, OsidNode

public interface CatalogNode
extends OsidNode

This interface is a container for a partial hierarchy retrieval. The number of hierarchy levels traversable through this interface depend on the number of levels requested in the CatalogHierarchySession.

Method Summary

Methods

Modifier and Type	Method and Description
Catalog	getCatalog() Gets the Catalog at this node.
CatalogNodeList	getChildCatalogNodes() Gets the children of this catalog.
CatalogNodeList	getParentCatalogNodes() Gets the parents of this catalog.

Methods inherited from interface org.osid.OsidNode

getChildIds, getParentIds, hasChildren, hasParents, isLeaf, isRoot

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Containable

isSequestered

Method Detail

getCatalog

Catalog getCatalog()

Gets the Catalog at this node.

Returns:

the catalog represented by this node

Compliance:

mandatory - This method must be implemented.

getParentCatalogNodes

CatalogNodeList getParentCatalogNodes()

Gets the parents of this catalog.

Returns:

the parents of the id

Compliance:

mandatory - This method must be implemented.

getChildCatalogNodes

CatalogNodeList getChildCatalogNodes()

Gets the children of this catalog.

Returns:

the children of this catalog

Compliance:

mandatory - This method must be implemented.