Source for file PropertiesIterator.php

<?php 
 
/**
 * PropertiesIterator provides access to these objects sequentially, one at a
 * time.  The purpose of all Iterators is to to offer a way for OSID methods
 * to return multiple values of a common type and not use an array.  Returning
 * an array may not be appropriate if the number of values returned is large
 * or is fetched remotely.  Iterators do not allow access to values by index,
 * rather you must access values in sequence. Similarly, there is no way to go
 * backwards through the sequence unless you place the values in a data
 * structure, such as an array, that allows for access by index.
 * 
 * <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.shared
 */
class PropertiesIterator
{
    /**
     * Return true if there is an additional  Properties object ; false
     * otherwise.
     *  
     * @return boolean 
     * 
     * @throws object SharedException An exception with one of the
     *          following messages defined in org.osid.shared.SharedException
     *          may be thrown:  {@link }
     *          org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
     *          {@link org.osid.shared.SharedException#PERMISSION_DENIED}
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.shared.SharedException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED}
     * 
     * @access public
     */
    function hasNextProperties () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
 
    /**
     * Return the next Properties.
     *  
     * @return object Properties 
     * 
     * @throws object SharedException An exception with one of the
     *          following messages defined in org.osid.shared.SharedException
     *          may be thrown:  {@link }
     *          org.osid.shared.SharedException#UNKNOWN_TYPE UNKNOWN_TYPE},
     *          {@link org.osid.shared.SharedException#PERMISSION_DENIED}
     *          PERMISSION_DENIED}, {@link }
     *          org.osid.shared.SharedException#CONFIGURATION_ERROR
     *          CONFIGURATION_ERROR}, {@link }
     *          org.osid.shared.SharedException#UNIMPLEMENTED UNIMPLEMENTED},
     *          {@link }
     *          org.osid.shared.SharedException#NO_MORE_ITERATOR_ELEMENTS
     *          NO_MORE_ITERATOR_ELEMENTS}
     * 
     * @access public
     */
    function nextProperties () { 
        die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class."); 
    } 
}
 
?>