Docs For Class GroupsFromNodesIterator

Description

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

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: GroupsFromNodesIterator.class.php,v 1.3 2007/09/04 20:25:36 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agent/GroupsFromNodesIterator.class.php (line 27)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniAgentIterator
         |
         --GroupsFromNodesIterator

Variable Summary

object $_nodeIterator

Method Summary

object GroupsFromNodesIterator (mixed $nodeIterator, object TraversalInfoIterator $traversalInfoIterator)

integer count ()

boolean hasNext ()

object Agent next ()

Variables

object $_nodeIterator (line 36)

since: 8/30/05
access: private

Inherited Variables

Inherited from HarmoniIterator

HarmoniIterator::$_elements
HarmoniIterator::$_i

Methods

Constructor GroupsFromNodesIterator (line 46)

Constructor

since: 8/30/05
access: public

object GroupsFromNodesIterator (mixed $nodeIterator, object TraversalInfoIterator $traversalInfoIterator)

object TraversalInfoIterator $traversalInfoIterator

count (line 106)

Gives the number of items in the iterator

since: 8/31/05
access: public

integer count ()

Redefinition of:

HarmoniIterator::count(): Gives the number of items in the iterator

hasNext (line 68)

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

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean hasNext ()

Redefinition of:

HarmoniIterator::hasNext()

next (line 92)

Return the next Agent.

access: public
throws: object AgentException An exception with one of the following messages defined in org.osid.agent.AgentException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS

object Agent next ()

Redefinition of:

HarmoniIterator::next()

Inherited Methods

Inherited From HarmoniAgentIterator

HarmoniAgentIterator::hasNextAgent()
HarmoniAgentIterator::nextAgent()

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()