org.osid.bidding

Interface BidList

All Superinterfaces:

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

public interface BidList
extends OsidList

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

Method Summary

Methods

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

getNextBid

Bid getNextBid()
               throws OperationFailedException

Gets the next Bid in this list.

Returns:

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

getNextBids

Bid[] getNextBids(long n)
                  throws OperationFailedException

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

Parameters:

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

Returns:

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