OSID Logo
OSID Specifications
bidding batch package
Version 3.1.0
Interfaceosid.bidding.batch.BidBatchFormList
Implementsosid.OsidList
Used Byosid.bidding.batch.BidBatchAdminSession
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.BidBatchForm the next BidBatchForm in this list. The hasNext() method should be used to test that a next BidBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.