OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ModelList
Implementsosid.OsidList
Description

Like all OsidLists, ModelList provides a means for accessing Model elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (ml.hasNext()) {
                          Model model = ml.getNextModel();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ml.hasNext()) {
                          Model[] models = ml.getNextModels(ml.available());
                     }
                     
                                 
                     
                
MethodgetNextModel
Description

Gets the next Model in this list.

Returnosid.inventory.Modelthe next Model in this list. The hasNext() method should be used to test that a next Model is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextModels
Description

Gets the next set of Model elements in this list. The specified amount must be less than or equal to the return from available().

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