OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.CatalogList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cl.hasNext()) {
                          Catalog catalog = cl.getNextCatalog();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Catalog[] catalogs = cl.getNextCatalogs(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCatalog
Description

Gets the next Catalog in this list.

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

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

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