OSID Logo
OSID Specifications
bidding package
Version 3.1.0
Interfaceosid.bidding.AuctionHouseList
Implementsosid.OsidList
Used Byosid.bidding.AuctionAuctionHouseSession
osid.bidding.AuctionHouseHierarchySession
osid.bidding.AuctionHouseLookupSession
osid.bidding.AuctionHouseQuerySession
osid.bidding.AuctionHouseSearchResults
osid.bidding.BidAuctionHouseSession
osid.bidding.rules.AuctionConstrainerAuctionHouseSession
osid.bidding.rules.AuctionConstrainerEnablerAuctionHouseSession
osid.bidding.rules.AuctionProcessorAuctionHouseSession
osid.bidding.rules.AuctionProcessorEnablerAuctionHouseSession
show 1 more…
osid.bidding.rules.BidEnablerAuctionHouseSession
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.AuctionHouse the next AuctionHouse in this list. The hasNext() method should be used to test that a next AuctionHouse 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.
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().

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