org.osid.course.chronicle.batch

Interface ProgramEntryPeerList

All Superinterfaces:

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

public interface ProgramEntryPeerList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            ProgramEntryPeer peer = ppl.getNextProgramEntryPeer();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            ProgramEntryPeer[] peers = ppl.getNextProgramEntryPeers(ppl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProgramEntryPeer

ProgramEntryPeer getNextProgramEntryPeer()
                                         throws OperationFailedException

Gets the next ProgramEntryPeer in this list.

Returns:

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

getNextProgramEntryPeers

ProgramEntryPeer[] getNextProgramEntryPeers(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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