OSID - osid.inventory.StockList Service Interface Definition

Interface	osid.inventory.StockList
Implements	`osid.OsidList`
Used By	`osid.inventory.StockHierarchySession`
	`osid.inventory.StockLookupSession`
	`osid.inventory.StockQuerySession`
	`osid.inventory.StockSearchResults`
	`osid.inventory.StockWarehouseSession`
Description	Like all `OsidLists`, `StockList` provides a means for accessing `Stock` elements sequentially either one at a time or many at a time. Examples: while (sl.hasNext()) { Stock stock = sl.getNextStock(); } or while (sl.hasNext()) { Stock[] stocks = sl.getNextStocks(sl.available()); }
Method	getNextStock
Description	Gets the next `Stock` in this list.
Return	`osid.inventory.Stock`		the next `Stock` in this list. The `hasNext()` method should be used to test that a next `Stock` 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	getNextStocks
Description	Gets the next set of `Stock` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Stock` elements requested which must be less than or equal to `available()`
Return	`osid.inventory.Stock[]`		an array of `Stock` 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.