OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.WarehouseList
Implementsosid.OsidList
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());
                     }
                     
                                 
                     
                
MethodgetNextWarehouse
Description

Gets the next Warehouse in this list.

Returnosid.inventory.Warehousethe next Warehouse in this list. The hasNext() method should be used to test that a next Warehouse is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextWarehouses
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().

Parameterscardinalnthe number of Warehouse elements requested which must be less than or equal to available()
Returnosid.inventory.Warehouse[]an array of Warehouse elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.