org.osid.bidding

Interface AuctionHouseNodeList

All Superinterfaces:

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

public interface AuctionHouseNodeList
extends OsidList

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

       
       
       while (ahnl.hasNext()) {
            AuctionHouseNode node = ahnl.getNextAuctionHouseNode();
       }
       
                   
       
  

or

       
       
       while (ahnl.hasNext()) {
            AuctionHouseNode[] nodes = fnl.getNextAuctionHouseNodes(ahnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAuctionHouseNode

AuctionHouseNode getNextAuctionHouseNode()
                                         throws OperationFailedException

Gets the next AuctionHouseNode in this list.

Returns:

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

getNextAuctionHouseNodes

AuctionHouseNode[] getNextAuctionHouseNodes(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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