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

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

                     
                     
                     while (pl.hasNext()) {
                          Program program = pl.getNextProgram();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Program[] programs = pl.getNextPrograms(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProgram
Description

Gets the next Program in this list.

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

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

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