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

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

                     
                     
                     while (bl.hasNext()) {
                          Bid bid = bl.getNextBid();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Bid[] bids = bl.getNextBids(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBid
Description

Gets the next Bid in this list.

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

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

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