Class HarmoniEnrollmentRecordIterator

Description

EnrollmentRecordIterator provides access to EnrollmentRecords.

EnrollmentRecord 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>

Located in /harmoni/core/oki2/coursemanagement/EnrollmentRecordIterator.class.php (line 28)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniEnrollmentRecordIterator
Method Summary
object EnrollmentRecord nextEnrollmentRecord ()
Variables
Methods
hasNextEnrollmentRecord (line 53)

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

  • access: public
  • throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextEnrollmentRecord ()
nextEnrollmentRecord (line 79)

Return the next EnrollmentRecord.

  • access: public
  • throws: object CourseManagementException An exception with one of the following messages defined in org.osid.coursemanagement.CourseManagementException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object EnrollmentRecord nextEnrollmentRecord ()

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:02 -0400 by phpDocumentor 1.3.0RC3