OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rl.hasNext()) {
                          Registration registration = rl.getNextRegistration();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Registration[] registrations = rl.getNextRegistrations(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRegistration
Description

Gets the next Registration in this list.

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

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

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