Class HarmoniGradableObjectIterator

Description

GradableObjectIterator 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 org.osid.SidImplementationLicenseMIT. </p>

  • copyright: Copyright &copy; 2005, Middlebury College
  • version: $Id: HarmoniIterator.class.php,v 1.12 2007/09/04 20:25:48 adamfranco Exp $
  • author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>

Located in /harmoni/core/oki2/grading/HarmoniGradableObjectIterator.class.php (line 27)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniGradableObjectIterator
Method Summary
Variables
Methods
hasNextGradableObject (line 48)

Return true if there is an additional GradableObject ; false otherwise.

  • access: public
  • throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextGradableObject ()
nextGradableObject (line 73)

Return the next GradableObject.

  • access: public
  • throws: object GradingException An exception with one of the following messages defined in org.osid.grading.GradingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object GradableObject nextGradableObject ()

Inherited Methods

Inherited From HarmoniIterator

HarmoniIterator::HarmoniIterator()
HarmoniIterator::add()
HarmoniIterator::count()
HarmoniIterator::hasNext()
HarmoniIterator::next()
HarmoniIterator::skipNext()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()

Documentation generated on Wed, 19 Sep 2007 10:23:57 -0400 by phpDocumentor 1.3.0RC3