Source for file TraversalInfo.php

<?php 
 
/**
 * 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 {@link org.osid.SidImplementationLicenseMIT MIT}
 * O.K.I&#46; OSID Definition License}.
 * </p>
 * 
 * @package org.osid.hierarchy
 */
class TraversalInfo
{
    /**
     * Get the unique Id for this Node.
     *  
     * @return object Id 
     * 
     * @throws object HierarchyException An exception with one of
     *          the following messages defined in
     *          org.osid.hierarchy.HierarchyException may be thrown:  {@link }
     *          org.osid.hierarchy.HierarchyException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getNodeId () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Get the display name for this Node.
     *  
     * @return string 
     * 
     * @throws object HierarchyException An exception with one of
     *          the following messages defined in
     *          org.osid.hierarchy.HierarchyException may be thrown:  {@link }
     *          org.osid.hierarchy.HierarchyException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getDisplayName () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * 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.
     *  
     * @return int 
     * 
     * @throws object HierarchyException An exception with one of
     *          the following messages defined in
     *          org.osid.hierarchy.HierarchyException may be thrown:  {@link }
     *          org.osid.hierarchy.HierarchyException#OPERATION_FAILED
     *          OPERATION_FAILED}, {@link }
     *          org.osid.hierarchy.HierarchyException#PERMISSION_DENIED
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.hierarchy.HierarchyException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.hierarchy.HierarchyException#UNIMPLEMENTED
     *          UNIMPLEMENTED}
     * 
     * @access public
     */
    function getLevel () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>