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

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

                     
                     
                     while (ll.hasNext()) {
                          Lesson lesson = ll.getNextLesson();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ll.hasNext()) {
                          Lesson[] lessons = ll.getNextLessons(ll.available());
                     }
                     
                                 
                     
                
MethodgetNextLesson
Description

Gets the next Lesson in this list.

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

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

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