org.osid.assessment

Interface AssessmentTakenList

All Superinterfaces:

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

public interface AssessmentTakenList
extends OsidList

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

       
       
       while (atl.hasNext()) {
            AssessmentTaken assessment = atl.getNextAssessmentTaken();
       
                   
       
  

or

       
       
       while (atl.hasNext()) {
            AssessmentTaken[] assessments = atl.hetNextAssessmentsTaken(atl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentTaken[]	getNextAssessmentsTaken(long n) Gets the next set of AssessmentTaken elements in this list which must be less than or equal to the number returned from available().
AssessmentTaken	getNextAssessmentTaken() Gets the next AssessmentTaken 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

getNextAssessmentTaken

AssessmentTaken getNextAssessmentTaken()
                                       throws OperationFailedException

Gets the next AssessmentTaken in this list.

Returns:

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

getNextAssessmentsTaken

AssessmentTaken[] getNextAssessmentsTaken(long n)
                                          throws OperationFailedException

Gets the next set of AssessmentTaken elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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