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

Gets the next Inventory in this list.

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

Parameterscardinalnthe number of Inventory elements requested which must be less than or equal to available()
Returnosid.inventory.Inventory[]an array of Inventory 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.