OSID - osid.inventory.ModelList Service Interface Definition

Interface	osid.inventory.ModelList
Implements	`osid.OsidList`
Used By	`osid.inventory.ModelLookupSession`
	`osid.inventory.ModelQuerySession`
	`osid.inventory.ModelSearchResults`
	`osid.inventory.ModelWarehouseSession`
	`osid.inventory.Stock`
Description	Like all `OsidLists`, `ModelList` provides a means for accessing `Model` elements sequentially either one at a time or many at a time. Examples: while (ml.hasNext()) { Model model = ml.getNextModel(); } or while (ml.hasNext()) { Model[] models = ml.getNextModels(ml.available()); }
Method	getNextModel
Description	Gets the next `Model` in this list.
Return	`osid.inventory.Model`		the next `Model` in this list. The `hasNext()` method should be used to test that a next `Model` 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	getNextModels
Description	Gets the next set of `Model` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Model` elements requested which must be less than or equal to `available()`
Return	`osid.inventory.Model[]`		an array of `Model` 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.