OSID Logo
OSID Specifications
lexicon batch package
Version 3.1.0
Interfaceosid.lexicon.batch.ParameterBatchFormList
Implementsosid.OsidList
Used Byosid.lexicon.batch.ParameterBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     ParameterBatchForm form = pbfl.getNextParameterBatchForm();
}

or

while (p
                
bf
l.hasNext()) {
     ParameterBatchForm[] forms = pbfl.getNextParameterBatchForms(pbfl.available());
}
                
MethodgetNextParameterBatchForm
Description

Gets the next ParameterBatchForm in this list.

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

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

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