org.osid.inquiry.batch

Interface ResponsePeerList

All Superinterfaces:

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

public interface ResponsePeerList
extends OsidList

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

       
       
       while (rpl.hasNext()) {
            ResponsePeer peer = rpl.getNextResponsePeer();
       }
       
                   
       
  

or

       
       
       while (rpl.hasNext()) {
            ResponsePeer[] peers = rpl.getNextResponsePeers(rpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResponsePeer

ResponsePeer getNextResponsePeer()
                                 throws OperationFailedException

Gets the next ResponsePeer in this list.

Returns:

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

getNextResponsePeers

ResponsePeer[] getNextResponsePeers(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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