org.osid.course.chronicle

Interface AssessmentEntryList

All Superinterfaces:

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

public interface AssessmentEntryList
extends OsidList

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

       
       
       while (ael.hasNext()) {
            AssessmentEntry entry = ael.getNextAssessmentEntry();
       }
       
                   
       
  

or

       
       
       while (ael.hasNext()) {
            AssessmentEntry[] entries = ael.getNextAssessmentEntries(ael.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAssessmentEntry

AssessmentEntry getNextAssessmentEntry()
                                       throws OperationFailedException

Gets the next AssessmentEntry in this list.

Returns:

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

getNextAssessmentEntries

AssessmentEntry[] getNextAssessmentEntries(long n)
                                           throws OperationFailedException

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

Parameters:

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

Returns:

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