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

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

                     
                     
                     while (aubfl.hasNext()) {
                          ActivityUnitBatchForm form = aubfl.getNextActivityUnitBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (aubfl.hasNext()) {
                          ActivityUnitBatchForm[] forms = aubfl.getNextActivityUnitBatchForms(aubfl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityUnitBatchForm
Description

Gets the next ActivityUnitBatchForm in this list.

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

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

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