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

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

                     
                     
                     while (arl.hasNext()) {
                          ActivityRegistration registration = arl.getNextActivityRegistration();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (arl.hasNext()) {
                          ActivityRegistration[] registrations = arl.getNextActivityRegistrations(arl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityRegistration
Description

Gets the next ActivityRegistration in this list.

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

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

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