Docs For Class HarmoniTraversalInfo

Description

TraversalInfo contains a Node unique Id, a Node displayName, and a Node Level. The level of the Node represented by the node unique Id is in relation to the startId of the Hierarchy traverse method call. Children Nodes are represented by positive levels, parent Nodes by negative levels.

For example, a traverse of a Hierarchy has level -1 for parents of the Node represented by startId, and a level -2 for grandparents. Similarly, the children of the Node would have level 1, and grandchildren would have level 2.

<p> OSID Version: 2.0

version: $Id: HarmoniTraversalInfo.class.php,v 1.9 2007/09/04 20:25:41 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/hierarchy/HarmoniTraversalInfo.class.php (line 26)

TraversalInfo
   |
   --HarmoniTraversalInfo

Variable Summary

integer $_depth

string $_displayName

object Id $_id

Method Summary

HarmoniTraversalInfo HarmoniTraversalInfo (object ID $id, string $displayName, integer $depth)

string getDisplayName ()

int getLevel ()

object Id getNodeId ()

Variables

integer $_depth (line 42)

var: The depth for this Node.

string $_displayName (line 37)

var: The display name for this Node.

object Id $_id (line 32)

var: The id for this Node.

Methods

Constructor HarmoniTraversalInfo (line 52)

Constructor.

access: public

HarmoniTraversalInfo HarmoniTraversalInfo (object ID $id, string $displayName, integer $depth)

object ID $id: The Id of this Node.
string $displayName: The displayName of the Node.
integer $depth: The depth of the Node.

getDisplayName (line 106)

Get the display name for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

Redefinition of:

TraversalInfo::getDisplayName(): Get the display name for this Node.

getLevel (line 131)

Get the level of this Node in relation to the startId of the Hierarchy traversal method call. Descendants are assigned increasingly positive levels; ancestors increasingly negative levels.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

int getLevel ()

Redefinition of:

TraversalInfo::getLevel(): Get the level of this Node in relation to the startId of the Hierarchy traversal method call. Descendants are assigned increasingly positive levels; ancestors increasingly negative levels.

getNodeId (line 83)

Get the unique Id for this Node.

access: public
throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getNodeId ()

Redefinition of:

TraversalInfo::getNodeId(): Get the unique Id for this Node.

Inherited Methods

Inherited From TraversalInfo

TraversalInfo::getDisplayName()
TraversalInfo::getLevel()
TraversalInfo::getNodeId()