org.osid.learning.batch

Interface ProficiencyPeerList

All Superinterfaces:

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

public interface ProficiencyPeerList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            ProficiencyPeer peer = ppl.getNextProficiencyPeer();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            ProficiencyPeer[] peers = ppl.getNextProficiencyPeers(epl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProficiencyPeer

ProficiencyPeer getNextProficiencyPeer()
                                       throws OperationFailedException

Gets the next ProficiencyPeer in this list.

Returns:

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

getNextProficiencyPeers

ProficiencyPeer[] getNextProficiencyPeers(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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