OSID Logo
OSID Specifications
course program package
Version 3.1.0
Interfaceosid.course.program.ProgramOfferingList
Implementsosid.OsidList
Used Byosid.course.program.ProgramOfferingCourseCatalogSession
osid.course.program.ProgramOfferingLookupSession
osid.course.program.ProgramOfferingQuerySession
osid.course.program.ProgramOfferingSearchResults
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.ProgramOffering the next ProgramOffering in this list. The hasNext() method should be used to test that a next ProgramOffering is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.