OSID Logo
OSID Specifications
learning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.batch.ActivityBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          ActivityBatchForm form = abfl.getNextActivityBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          ActivityBatchForm[] forms = abfl.getNextActivityBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextActivityBatchForm
Description

Gets the next ActivityBatchForm in this list.

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

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

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