OSID Logo
OSID Specifications
learning batch package
Version 3.1.0
Interfaceosid.learning.batch.ObjectiveBatchFormList
Implementsosid.OsidList
Used Byosid.learning.batch.ObjectiveBatchAdminSession
Description

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

while (obfl.hasNext()) {
     ObjectiveBatchForm form = obfl.getNextObjectiveBatchForm();
}
                
or
while (obfl.hasNext()) {
     ObjectiveBatchForm[] forms = obfl.getNextObjectiveBatchForms(obfl.available());
}
                
MethodgetNextObjectiveBatchForm
Description

Gets the next ObjectiveBatchForm in this list.

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

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

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