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

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

                     
                     
                     while (pl.hasNext()) {
                          Package package = pl.getNextPackage();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Package[] packages = pl.getNextPackages(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPackage
Description

Gets the next Package in this list.

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

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

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