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

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

                     
                     
                     while (cnl.hasNext()) {
                          CatalogNode node = cnl.getNextCatalogNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cnl.hasNext()) {
                          CatalogNode[] nodes = cnl.getNextCatalogNodes(cnl.available());
                     }
                     
                                 
                     
                
MethodgetNextCatalogNode
Description

Gets the next CatalogNode in this list.

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

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

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