OSID Logo
OSID Specifications
bidding batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.batch.BidBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bbfl.hasNext()) {
                          BidBatchForm form = bbfl.getNextBidBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BidBatchForm[] forms = bbfl.getNextBidBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBidBatchForm
Description

Gets the next BidBatchForm in this list.

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

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

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