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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RegistrationBatchForm form = rbfl.getNextRegistrationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RegistrationBatchForm[] forms = rbfl.getNextRegistrationBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRegistrationBatchForm
Description

Gets the next RegistrationBatchForm in this list.

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

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

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