Docs For Class TraversalInfo

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 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/hierarchy/TraversalInfo.php (line 24)

Direct descendents

Class	Description
HarmoniTraversalInfo	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.

Method Summary

string getDisplayName ()

int getLevel ()

object Id getNodeId ()

Methods

getDisplayName (line 68)

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 ()

Redefined in descendants as:

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

getLevel (line 93)

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 ()

Redefined in descendants as:

HarmoniTraversalInfo::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 45)

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 ()

Redefined in descendants as:

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