Docs For Class LDAPAgentIterator

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: LDAPAgentIterator.class.php,v 1.3 2007/09/04 20:25:37 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agentmanagement/AuthNMethods/LDAPAgentIterator.class.php (line 27)

SObject
   |
   --HarmoniIterator
      |
      --HarmoniAgentIterator
         |
         --LDAPAgentIterator

Variable Summary

object $_agents

object $_dns

Method Summary

object LDAPAgentIterator (object LDAPAuthNMethod $authNMethod, ref $agents, [optional $dns = array()])

integer count ()

boolean hasNext ()

object Agent next ()

Variables

object $_agents (line 43)

since: 2/27/06
access: private

object $_dns (line 36)

since: 8/30/05
access: private

Inherited Variables

Inherited from HarmoniIterator

HarmoniIterator::$_elements
HarmoniIterator::$_i

Methods

Constructor LDAPAgentIterator (line 56)

Constructor

since: 8/30/05
access: public

object LDAPAgentIterator (object LDAPAuthNMethod $authNMethod, ref $agents, [optional $dns = array()])

object LDAPAuthNMethod $authNMethod
ref $agents: array $agents An array of agents to populate with our created Agent objects
optional $dns: array $dns

count (line 140)

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

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

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