OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.BidList
Implementsosid.OsidList
Used Byosid.bidding.BidAuctionHouseSession
osid.bidding.BidLookupSession
osid.bidding.BidQuerySession
osid.bidding.BidSearchResults
osid.bidding.MyAuctionSession
osid.bidding.rules.BidEnablerRuleLookupSession
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.Bid the next Bid in this list. The hasNext() method should be used to test that a next Bid 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.
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().

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