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

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

                     
                     
                     while (lal.hasNext()) {
                          LessonAnchor anchor = lal.getNextLessonAnchor();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (lal.hasNext()) {
                          LessonAnchor[] anchors = lal.getNextLessonAnchors(lal.available());
                     }
                     
                                 
                     
                
MethodgetNextLessonAnchor
Description

Gets the next LessonAnchor in this list.

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

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

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