OSID Logo
OSID Specifications
course registration batch package
Version 3.1.0
Interfaceosid.course.registration.batch.RegistrationBatchFormList
Implementsosid.OsidList
Used Byosid.course.registration.batch.RegistrationBatchAdminSession
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.RegistrationBatchForm the next RegistrationBatchForm in this list. The hasNext() method should be used to test that a next RegistrationBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.