org.osid.bidding.batch

Interface BidPeerList

All Superinterfaces:

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

public interface BidPeerList
extends OsidList

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

       
       
       while (bpl.hasNext()) {
            BidPeer peer = bpl.getNextBidPeer();
       }
       
                   
       
  

or

       
       
       while (bpl.hasNext()) {
            BidPeer[] peers = bpl.getNextBidPeers(bpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBidPeer

BidPeer getNextBidPeer()
                       throws OperationFailedException

Gets the next BidPeer in this list.

Returns:

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

getNextBidPeers

BidPeer[] getNextBidPeers(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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