org.osid.mapping

Interface LocationNode

All Superinterfaces:

Containable, Identifiable, OsidNode

public interface LocationNode
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 LocationHierarchySession.

Method Summary

Methods

Modifier and Type	Method and Description
LocationNodeList	getChildLocationNodes() Gets the children of this location.
Location	getLocation() Gets the Location at this node.
LocationNodeList	getParentLocationNodes() Gets the parents of this location.

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

getLocation

Location getLocation()

Gets the Location at this node.

Returns:

the location represented by this node

Compliance:

mandatory - This method must be implemented.

getParentLocationNodes

LocationNodeList getParentLocationNodes()

Gets the parents of this location.

Returns:

the parents of the id

Compliance:

mandatory - This method must be implemented.

getChildLocationNodes

LocationNodeList getChildLocationNodes()

Gets the children of this location.

Returns:

the children of this location

Compliance:

mandatory - This method must be implemented.