OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseCatalogNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ccnl.hasNext()) {
                          CourseCatalogNode node = ccnl.getNextCourseCatalogNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ccnl.hasNext()) {
                          CourseCatalogNode[] nodes = ccnl.getNextCourseCatalogNodes(ccnl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseCatalogNode
Description

Gets the next CourseCatalogNode in this list.

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

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

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