OSID - osid.inventory.WarehouseList Service Interface Definition

Interface	osid.inventory.WarehouseList
Implements	`osid.OsidList`
Used By	`osid.inventory.InventoryWarehouseSession`
	`osid.inventory.ItemWarehouseSession`
	`osid.inventory.ModelWarehouseSession`
	`osid.inventory.StockWarehouseSession`
	`osid.inventory.WarehouseHierarchySession`
	`osid.inventory.WarehouseLookupSession`
	`osid.inventory.WarehouseQuerySession`
	`osid.inventory.WarehouseSearchResults`
	`osid.inventory.shipment.ShipmentWarehouseSession`
Description	Like all `OsidLists`, `WarehouseList` provides a means for accessing `Warehouse` elements sequentially either one at a time or many at a time. Examples: while (wl.hasNext()) { Warehouse warehouse = wl.getNextWarehouse(); } or while (wl.hasNext()) { Warehouse[] warehouses = wl.getNextWarehouses(wl.available()); }
Method	getNextWarehouse
Description	Gets the next `Warehouse` in this list.
Return	`osid.inventory.Warehouse`		the next `Warehouse` in this list. The `hasNext()` method should be used to test that a next `Warehouse` 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	getNextWarehouses
Description	Gets the next set of `Warehouse` elements in this list. The specified amount must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Warehouse` elements requested which must be less than or equal to `available()`
Return	`osid.inventory.Warehouse[]`		an array of `Warehouse` 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.