OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CatalogueList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rl.hasNext()) {
                          Catalogue catalogue = rl.getNextCatalogue();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Catalogue[] catalogue = rl.getNextCatalogues(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextCatalogue
Description

Gets the next Catalogue in this list.

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

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

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