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

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

                     
                     
                     while (il.hasNext()) {
                          Installation install = il.getNextInstallation();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Installation[] installs = il.getNextInstallations(il.available());
                     }
                     
                                 
                     
                
MethodgetNextInstallation
Description

Gets the next Installation in this list.

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

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

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