org.osid.bidding

Interface AuctionList

All Superinterfaces:

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

public interface AuctionList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Auction auction = al.getNextAuction();
       }
       
                   
       
  

or

       
       
       while (el.hasNext()) {
            Auction[] auctions = al.getNextAuctions(al.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Auction	getNextAuction() Gets the next Auction in this list.
Auction[]	getNextAuctions(long n) Gets the next set of Auction 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

getNextAuction

Auction getNextAuction()
                       throws OperationFailedException

Gets the next Auction in this list.

Returns:

the next Auction in this list. The hasNext() method should be used to test that a next Auction 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.

getNextAuctions

Auction[] getNextAuctions(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

an array of Auction 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.