Class HarmoniTimespanIterator

Description

TimespanIterator 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/scheduling/HarmoniTimespanIterator.class.php (line 27)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniTimespanIterator
Method Summary
Variables
Methods
hasNextTimespan (line 49)

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

  • access: public
  • throws: object SchedulingException An exception with one of the following messages defined in org.osid.scheduling.SchedulingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextTimespan ()
nextTimespan (line 74)

Return the next Timespan.

  • access: public
  • throws: object SchedulingException An exception with one of the following messages defined in org.osid.scheduling.SchedulingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object Timespan nextTimespan ()

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