OSID Logo
OSID Specifications
course registration batch package
Version 3.1.0
Interfaceosid.course.registration.batch.CourseRegistrationBatchFormList
Implementsosid.OsidList
Used Byosid.course.registration.batch.CourseRegistrationBatchAdminSession
Description

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

while (crbfl.hasNext()) {
     CourseRegistrationBatchForm form = abfl.getNextCourseRegistrationBatchForm();
}
                
or
while (crbfl.hasNext()) {
     CourseRegistrationBatchForm[] forms = crbfl.getNextCourseRegistrationBatchForms(crbfl.available());
}
                
MethodgetNextCourseRegistrationBatchForm
Description

Gets the next CourseRegistrationBatchForm in this list.

Returnosid.course.registration.batch.CourseRegistrationBatchForm the next CourseRegistrationBatchForm in this list. The hasNext() method should be used to test that a next CourseRegistrationBatchForm 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.
MethodgetNextCourseRegistrationBatchForms
Description

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

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