OSID - osid.inventory.InventoryList Service Interface Definition

Interface	osid.inventory.InventoryList
Implements	`osid.OsidList`
Used By	`osid.inventory.InventoryLookupSession`
	`osid.inventory.InventoryQuerySession`
	`osid.inventory.InventorySearchResults`
	`osid.inventory.InventoryWarehouseSession`
Description	Like all `OsidLists`, `InventoryList` provides a means for accessing `Inventory` elements sequentially either one at a time or many at a time. Examples: while (il.hasNext()) { Inventory inventory = il.getNextInventory(); } or while (il.hasNext()) { Inventory[] inventories = il.getNextInventories(il.available()); }
Method	getNextInventory
Description	Gets the next `Inventory` in this list.
Return	`osid.inventory.Inventory`		the next `Inventory` in this list. The `hasNext()` method should be used to test that a next `Inventory` 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	getNextInventories
Description	Gets the next set of `Inventory` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Inventory` elements requested which must be less than or equal to `available()`
Return	`osid.inventory.Inventory[]`		an array of `Inventory` 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.