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

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

                     
                     
                     while (abfl.hasNext()) {
                          ActivityRegistrationBatchForm form = abfl.getNextActivityRegistrationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          ActivityRegistrationBatchForm[] forms = abfl.getNextActivityRegistrationBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityRegistrationBatchForm
Description

Gets the next ActivityRegistrationBatchForm in this list.

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

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

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