OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.BlockBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bbfl.hasNext()) {
                          BlockBatchForm form = bbfl.getNextBlockBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BlockBatchForm[] forms = bbfl.getNextBlockBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBlockBatchForm
Description

Gets the next BlockBatchForm in this list.

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

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

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