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

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

                     
                     
                     while (popl.hasNext()) {
                          ProgramOfferingPeer peer = popl.getNextProgramOfferingPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (popl.hasNext()) {
                          ProgramOfferingPeer[] peers = popl.getNextProgramOfferingPeers(epl.available());
                     }
                     
                                 
                     
                
MethodgetNextProgramOfferingPeer
Description

Gets the next ProgramOfferingPeer in this list.

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

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

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