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

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

                     
                     
                     while (icl.hasNext()) {
                          InstallationContent content = ifl.getNextInstallationContent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (icl.hasNext()) {
                          InstallationContent[] content = icl.getNextInstallationContents(icl.available());
                     }
                     
                                 
                     
                
MethodgetNextInstallationContent
Description

Gets the next InstallationContent in this list.

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

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

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