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

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

                     
                     
                     while (abfl.hasNext()) {
                          AuctionBatchForm form = abfl.getNextAuctionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AuctionBatchForm[] forms = abfl.getNextAuctionBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuctionBatchForm
Description

Gets the next AuctionBatchForm in this list.

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

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

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