OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.DepotList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dl.hasNext()) {
                          Depot depot = dl.getNextDepot();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dl.hasNext()) {
                          Depot[] depots = dl.getNextDepots(dl.available());
                     }
                     
                                 
                     
                
MethodgetNextDepot
Description

Gets the next Depot in this list.

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

Gets the next set of Depot elements in this list which must be less than or equal to the return from available().

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