org.osid.offering.batch

Interface ParticipantPeerList

All Superinterfaces:

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

public interface ParticipantPeerList
extends OsidList

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

       
       
       while (popl.hasNext()) {
            ParticipantPeer peer = popl.getNextParticipantPeer();
       }
       
                   
       
  

or

       
       
       while (popl.hasNext()) {
            ParticipantPeer[] peers = popl.getNextParticipantPeers(popl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextParticipantPeer

ParticipantPeer getNextParticipantPeer()
                                       throws OperationFailedException

Gets the next ParticipantPeer in this list.

Returns:

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

getNextParticipantPeers

ParticipantPeer[] getNextParticipantPeers(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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