org.osid.course.chronicle.batch

Interface AwardEntryPeerList

All Superinterfaces:

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

public interface AwardEntryPeerList
extends OsidList

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

       
       
       while (apl.hasNext()) {
            AwardEntryPeer peer = apl.getNextAwardEntryPeer();
       }
       
                   
       
  

or

       
       
       while (apl.hasNext()) {
            AwardEntryPeer[] peers = apl.getNextAwardEntryPeers(apl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAwardEntryPeer

AwardEntryPeer getNextAwardEntryPeer()
                                     throws OperationFailedException

Gets the next AwardEntryPeer in this list.

Returns:

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

getNextAwardEntryPeers

AwardEntryPeer[] getNextAwardEntryPeers(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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