org.osid.assessment

Interface AssessmentOfferedList

All Superinterfaces:

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

public interface AssessmentOfferedList
extends OsidList

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

       
       
       while (aol.hasNext()) {
            AssessmentOffered assessment = aol.getNextAssessmentOffered();
       
                   
       
  

or

       
       
       while (aol.hasNext()) {
            AssessmentOffered[] assessments = aol.hetNextAssessmentsOffered(aol.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentOffered	getNextAssessmentOffered() Gets the next AssessmentOffered in this list.
AssessmentOffered[]	getNextAssessmentsOffered(long n) Gets the next set of AssessmentOffered elements in this list which must be less than or equal to the number returned from available().

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

getNextAssessmentOffered

AssessmentOffered getNextAssessmentOffered()
                                           throws OperationFailedException

Gets the next AssessmentOffered in this list.

Returns:

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

getNextAssessmentsOffered

AssessmentOffered[] getNextAssessmentsOffered(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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