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

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

                     
                     
                     while (cl.hasNext()) {
                          Course course = cl.getNextCourse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Course[] courses = cl.getNextCourses(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourse
Description

Gets the next Course in this list.

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

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

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