org.osid.bidding.rules

Interface AuctionConstrainerList

All Superinterfaces:

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

public interface AuctionConstrainerList
extends OsidList

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

       
       
       while (acl.hasNext()) {
            AuctionConstrainer = acl.getNextAuctionConstrainer();
       }
       
                   
       
  

or

       
       
       while (acl.hasNext()) {
            AuctionConstrainer[] = acel.getNextAuctionConstrainers(acl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAuctionConstrainer

AuctionConstrainer getNextAuctionConstrainer()
                                             throws OperationFailedException

Gets the next AuctionConstrainer in this list.

Returns:

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

getNextAuctionConstrainers

AuctionConstrainer[] getNextAuctionConstrainers(long n)
                                                throws OperationFailedException

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

Parameters:

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

Returns:

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