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

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

                     
                     
                     while (pol.hasNext()) {
                          ProgramOffering offering = pol.getNextProgramOffering();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pol.hasNext()) {
                          ProgramOffering[] offerings = pol.getNextProgramOfferings(pol.available());
                     }
                     
                                 
                     
                
MethodgetNextProgramOffering
Description

Gets the next ProgramOffering in this list.

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

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

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