OSID - osid.lexicon.IdiomList Service Interface Definition

Interface	osid.lexicon.IdiomList
Implements	`osid.OsidList`
Used By	`osid.lexicon.IdiomLookupSession`
	`osid.lexicon.IdiomPressSession`
	`osid.lexicon.IdiomQuerySession`
	`osid.lexicon.IdiomSearchResults`
Description	Like all `OsidLists` , `IdiomList` provides a means for accessing `Idiom` elements sequentially either one at a time or many at a time. Examples: while (il.hasNext()) { Idiom idiom = il.getNextIdiom(); } or while (il.hasNext()) { Idiom[] idioms = il.getNextIdioms(il.available()); }
Method	getNextIdiom
Description	Gets the next `Idiom` in this list.
Return	`osid.lexicon.Idiom`		the next `Idiom` in this list. The `hasNext()` method should be used to test that a next `Idiom` 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	getNextIdioms
Description	Gets the next set of `Idiom` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Idiom` elements requested which must be less than or equal to `available()`
Return	`osid.lexicon.Idiom[]`		an array of `Idiom` 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.