OSID - osid.messaging.MessageList Service Interface Definition

Interface	osid.messaging.MessageList
Implements	`osid.OsidList`
Used By	`osid.messaging.MessageLookupSession`
	`osid.messaging.MessageMailboxSession`
	`osid.messaging.MessageQuerySession`
	`osid.messaging.MessageSearchResults`
	`osid.messaging.MessagingSession`
Description	Like all `OsidLists`, `MessageList` provides a means for accessing `Message` elements sequentially either one at a time or many at a time. Examples: while (ml.hasNext()) { Message message = ml.getNextMessage(); } or while (ml.hasNext()) { Message[] messages = ml.getNextMessages(ml.available()); }
Method	getNextMessage
Description	Gets the next `Message` in this list.
Return	`osid.messaging.Message`		the next `Message` in this list. The `hasNext()` method should be used to test that a next `Message` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextMessages
Description	Gets the next set of `Messages` in this list which must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Message` elements requested which must be less than or equal to `available()`
Return	`osid.messaging.Message[]`		an array of `Message` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.