org.osid.assessment.authoring

Interface AssessmentPartList

All Superinterfaces:

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

public interface AssessmentPartList
extends OsidList

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

       
       
       while (apl.hasNext()) {
            AssessmentPart assessmentPart = apl.getNextAssessmentPart();
       }
       
                   
       
  

or

       
       
       while (apl.hasNext()) {
            AssessmentPart[] assessmentParts = apl.hetNextAssessmentParts(apl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAssessmentPart

AssessmentPart getNextAssessmentPart()
                                     throws OperationFailedException

Gets the next AssessmentPart in this list.

Returns:

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

getNextAssessmentParts

AssessmentPart[] getNextAssessmentParts(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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