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

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

                     
                     
                     while (ccl.hasNext()) {
                          CourseCatalog catalog = ccl.getNextCourseCatalog();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ccl.hasNext()) {
                          CourseCatalog[] catalogs = ccl.getNextCourseCatalogs(ccl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseCatalog
Description

Gets the next CourseCatalog in this list.

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

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

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