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

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

                     
                     
                     while (el.hasNext()) {
                          Enrollment enrollment = el.getNextEnrollment();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (el.hasNext()) {
                          Enrollment[] enrollments = el.getNextEnrollments(el.available());
                     }
                     
                                 
                     
                
MethodgetNextEnrollment
Description

Gets the next Enrollment in this list.

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

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

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