org.osid.course.program.batch

Interface ProgramOfferingPeerList

All Superinterfaces:

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

public interface ProgramOfferingPeerList
extends OsidList

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

       
       
       while (popl.hasNext()) {
            ProgramOfferingPeer peer = popl.getNextProgramOfferingPeer();
       }
       
                   
       
  

or

       
       
       while (popl.hasNext()) {
            ProgramOfferingPeer[] peers = popl.getNextProgramOfferingPeers(epl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProgramOfferingPeer

ProgramOfferingPeer getNextProgramOfferingPeer()
                                               throws OperationFailedException

Gets the next ProgramOfferingPeer in this list.

Returns:

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

getNextProgramOfferingPeers

ProgramOfferingPeer[] getNextProgramOfferingPeers(long n)
                                                  throws OperationFailedException

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

Parameters:

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

Returns:

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