org.osid.course.chronicle.batch

Interface AssessmentEntryPeerList

All Superinterfaces:

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

public interface AssessmentEntryPeerList
extends OsidList

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

       
       
       while (apl.hasNext()) {
            AssessmentEntryPeer peer = apl.getNextAssessmentEntryPeer();
       }
       
                   
       
  

or

       
       
       while (apl.hasNext()) {
            AssessmentEntryPeer[] peers = apl.getNextAssessmentEntryPeers(apl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAssessmentEntryPeer

AssessmentEntryPeer getNextAssessmentEntryPeer()
                                               throws OperationFailedException

Gets the next AssessmentEntryPeer in this list.

Returns:

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

getNextAssessmentEntryPeers

AssessmentEntryPeer[] getNextAssessmentEntryPeers(long n)
                                                  throws OperationFailedException

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

Parameters:

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

Returns:

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