Class MessageIterator

Description

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

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/usermessaging/MessageIterator.php (line 24)


	
			
Method Summary
Methods
hasNextMessage (line 46)

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

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED
boolean hasNextMessage ()
nextMessage (line 72)

Return the next Message.

  • access: public
  • throws: object UsermessagingException An exception with one of the following messages defined in org.osid.usermessaging.UsermessagingException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NO_MORE_ITERATOR_ELEMENTS
object Message nextMessage ()

Documentation generated on Wed, 19 Sep 2007 10:25:04 -0400 by phpDocumentor 1.3.0RC3