OSID Logo
OSID Specifications
resource batch package
Version 3.1.0
Interfaceosid.resource.batch.BinBatchFormList
Implementsosid.OsidList
Used Byosid.resource.batch.BinBatchAdminSession
Description

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

while (bbfl.hasNext()) {
     BinBatchForm form = bbfl.getNextBinBatchForm();
}
                
or
while (bbfl.hasNext()) {
     BinBatchForm[] forms = bbfl.getNextBinBatchForms(bbfl.available());
}
                
MethodgetNextBinBatchForm
Description

Gets the next BinBatchForm in this list.

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

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

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