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

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

                     
                     
                     while (epl.hasNext()) {
                          EnrollmentPeer peer = epl.getNextEnrollmentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (epl.hasNext()) {
                          EnrollmentPeer[] peers = epl.getNextEnrollmentPeers(epl.available());
                     }
                     
                                 
                     
                
MethodgetNextEnrollmentPeer
Description

Gets the next EnrollmentPeer in this list.

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

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

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