OSID - osid.lexicon.TextList Service Interface Definition

Interface	osid.lexicon.TextList
Implements	`osid.OsidList`
Used By	`osid.lexicon.TextLookupSession`
	`osid.lexicon.TextPressSession`
	`osid.lexicon.TextQuerySession`
	`osid.lexicon.TextSearchResults`
Description	Like all `OsidLists` , `TextList` provides a means for accessing `Text` elements sequentially either one at a time or many at a time. Examples: while (tl.hasNext()) { Text text = tl.getNextText(); } or while (tl.hasNext()) { Text[] texts = tl.getNextTexts(tl.available()); }
Method	getNextText
Description	Gets the next `Text` in this list.
Return	`osid.lexicon.Text`		the next `Text` in this list. The `hasNext()` method should be used to test that a next `Text` 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	getNextTexts
Description	Gets the next set of `Text` elements in this list. The specified amount must be less than or equal to the return from `available()` .
Parameters	`cardinal`	`n`	the number of `Text` elements requested which must be less than or equal to `available()`
Return	`osid.lexicon.Text[]`		an array of `Text` 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.