Documentation is available at ObjectIterator.php
- <?php
- /**
- * ObjectIterator 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. To maximize
- * reuse and implementation substitutability, it is important not to reference
- * a class in one OSID implementation directly in another. Interfaces should
- * be used and new called only on objects in the implementation package. To
- * avoid binding a specific implementation of Shared to a specific
- * implementaiton of some other OSID, implementations TypeIterator and the
- * other primitative-type Iterators should reside in each OSID that requires
- * them and not in an implementation of Shared. For example, if an
- * implementation of org.osid.logging.LoggingManager needs a class that
- * implements org.osid.shared.StringIterator, the class should be in the
- * package implementing Logging.
- *
- * <p>
- * OSID Version: 2.0
- * </p>
- *
- * <p>
- * Licensed under the {@link org.osid.SidImplementationLicenseMIT MIT}
- * O.K.I. OSID Definition License}.
- * </p>
- *
- * @package org.osid.shared
- */
- class ObjectIterator
- {
- /**
- * Return true if there is an additional 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 hasNextObject () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- /**
- * Return the next Object.
- *
- * @return object mixed (original type: java.io.Serializable)
- *
- * @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 nextObject () {
- die ("Method <b>".__FUNCTION__."()</b> declared in interface<b> ".__CLASS__."</b> has not been overloaded in a child class.");
- }
- }
- ?>
Documentation generated on Wed, 19 Sep 2007 10:25:17 -0400 by phpDocumentor 1.3.0RC3