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

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

                     
                     
                     while (ahl.hasNext()) {
                          AuctionHouse house = ahl.getNextAuctionHouse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ahl.hasNext()) {
                          AuctionHouse[] houses = ahl.getNextAuctionHouses(ahl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuctionHouse
Description

Gets the next AuctionHouse in this list.

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

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

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