Class HarmoniIdIterator

Description

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

Located in /harmoni/core/oki2/shared/HarmoniIdIterator.class.php (line 37)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniIdIterator
Method Summary
boolean hasNextId ()
object Id nextId ()
Variables
Methods
hasNextId (line 58)

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

  • access: public
  • throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextId ()
nextId (line 82)

Return the next Id.

  • access: public
  • throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object Id nextId ()

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