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

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

                     
                     
                     while (pl.hasNext()) {
                          Plan plan = pl.getNextPlan();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Plan[] plans = pl.getNextPlans(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPlan
Description

Gets the next Plan in this list.

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

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

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