org.osid.bidding.batch

Interface AuctionBatchFormList

All Superinterfaces:

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

public interface AuctionBatchFormList
extends OsidList

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

       
       
       while (abfl.hasNext()) {
            AuctionBatchForm form = abfl.getNextAuctionBatchForm();
       }
       
                   
       
  

or

       
       
       while (abfl.hasNext()) {
            AuctionBatchForm[] forms = abfl.getNextAuctionBatchForms(abfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAuctionBatchForm

AuctionBatchForm getNextAuctionBatchForm()
                                         throws OperationFailedException

Gets the next AuctionBatchForm in this list.

Returns:

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

getNextAuctionBatchForms

AuctionBatchForm[] getNextAuctionBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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