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

Gets the next Stock in this list.

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

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