Docs For Class MembersOnlyFromTraversalIterator

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: MembersOnlyFromTraversalIterator.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/MembersOnlyFromTraversalIterator.class.php (line 26)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniAgentIterator
         |
         --AgentFilteringFromTraversalIterator
            |
            --MembersOnlyFromTraversalIterator

Method Summary

object Agent _getAgent (object Id $id)

boolean _shouldSelect (object Id $id)

Variables

Inherited Variables

Inherited from AgentFilteringFromTraversalIterator

AgentFilteringFromTraversalIterator::$_count
AgentFilteringFromTraversalIterator::$_nextAgent
AgentFilteringFromTraversalIterator::$_traversalInfoIterator

Inherited from HarmoniIterator

HarmoniIterator::$_elements
HarmoniIterator::$_i

Methods

_getAgent (line 56)

create a new Agent of the appropriate class and return it.

since: 8/31/05
access: private

object Agent _getAgent (object Id $id)

object Id $id

Redefinition of:

AgentFilteringFromTraversalIterator::_getAgent(): create a new Agent of the appropriate class and return it.

_shouldSelect (line 40)

Return True if we should select the Agent with the given id, FALSE if we are filtering it.

since: 8/31/05
access: private

boolean _shouldSelect (object Id $id)

object Id $id

Redefinition of:

AgentFilteringFromTraversalIterator::_shouldSelect(): Return True if we should select the Agent with the given id, FALSE if we are filtering it.

Inherited Methods

Inherited From AgentFilteringFromTraversalIterator

AgentFilteringFromTraversalIterator::AgentFilteringFromTraversalIterator()
AgentFilteringFromTraversalIterator::count()
AgentFilteringFromTraversalIterator::hasNext()
AgentFilteringFromTraversalIterator::next()
AgentFilteringFromTraversalIterator::_getAgent()
AgentFilteringFromTraversalIterator::_selectNextAgent()
AgentFilteringFromTraversalIterator::_shouldSelect()

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