org.osid.recognition.batch

Interface ConferralPeerList

All Superinterfaces:

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

public interface ConferralPeerList
extends OsidList

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

       
       
       while (cpl.hasNext()) {
            ConferralPeer peer = cpl.getConferralPeer();
       }
       
                   
       
  

or

       
       
       while (cpl.hasNext()) {
            ConferralPeer[] peers = cbfl.getNextConferralPeers(cpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextConferralPeer

ConferralPeer getNextConferralPeer()
                                   throws OperationFailedException

Gets the next ConferralPeer in this list.

Returns:

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

getNextConferralPeers

ConferralPeer[] getNextConferralPeers(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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