Class HarmoniAssetIterator

Description

AssetIterator 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/repository/HarmoniAssetIterator.class.php (line 37)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniAssetIterator
Direct descendents
Class Description
FromNodesAssetIterator The FromNodesAsset iterator lazily fetches assets as they are requested.
Method Summary
boolean hasNextAsset ()
object Asset next ()
object Asset nextAsset ()
Variables
Methods
hasNextAsset (line 61)

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

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextAsset ()
next (line 111)

Return the next Asset.

  • access: public
  • throws: object HierarchyException An exception with one of the following messages defined in org.osid.hierarchy.HierarchyException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object Asset next ()

Redefinition of:
HarmoniIterator::next()

Redefined in descendants as:
nextAsset (line 86)

Return the next Asset.

  • access: public
  • throws: object RepositoryException An exception with one of the following messages defined in org.osid.repository.RepositoryException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object Asset nextAsset ()

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