org.osid.bidding

Interface AuctionHouseList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface AuctionHouseList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AuctionHouse	getNextAuctionHouse() Gets the next AuctionHouse in this list.
AuctionHouse[]	getNextAuctionHouses(long n) Gets the next set of AuctionHouse elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextAuctionHouse

AuctionHouse getNextAuctionHouse()
                                 throws OperationFailedException

Gets the next AuctionHouse in this list.

Returns:

the next AuctionHouse in this list. The hasNext() method should be used to test that a next AuctionHouse is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextAuctionHouses

AuctionHouse[] getNextAuctionHouses(long n)
                                    throws OperationFailedException

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

Parameters:

n - the number of AuctionHouse elements requested which must be less than or equal to available()

Returns:

an array of AuctionHouse elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.