OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.ProgramEntryList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pel.hasNext()) {
                          ProgramEntry entry = pel.getNextProgramEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pel.hasNext()) {
                          ProgramEntry[] enrties = pel.getNextProgramEntries(pel.available());
                     }
                     
                                 
                     
                
MethodgetNextProgramEntry
Description

Gets the next ProgramEntry in this list.

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

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

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