Class HarmoniAgentIterator

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>

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

SObject
   |
   --HarmoniIterator
      |
      --HarmoniAgentIterator
Direct descendents
Class Description
AgentFilteringFromTraversalIterator AgentIterator provides access to these objects sequentially, one at a time.
GroupsFromNodesIterator AgentIterator provides access to these objects sequentially, one at a time.
UsersGroupIterator The UsersGroupIterator takes an AgentIterator and filters out the Anonymous user.
LDAPAgentIterator AgentIterator provides access to these objects sequentially, one at a time.
Method Summary
boolean hasNextAgent ()
object Agent nextAgent ()
Variables
Methods
hasNextAgent (line 50)

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 hasNextAgent ()
nextAgent (line 74)

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

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