org.osid.bidding.rules

Interface AuctionProcessorList

All Superinterfaces:

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

public interface AuctionProcessorList
extends OsidList

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

       
       
       while (apl.hasNext()) {
            AuctionProcessor = apl.getNextAuctionProcessor();
       }
       
                   
       
  

or

       
       
       while (apl.hasNext()) {
            AuctionProcessor[] = apl.getNextAuctionProcessors(apl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAuctionProcessor

AuctionProcessor getNextAuctionProcessor()
                                         throws OperationFailedException

Gets the next AuctionProcessor in this list.

Returns:

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

getNextAuctionProcessors

AuctionProcessor[] getNextAuctionProcessors(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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