org.osid.course.requisite

Interface CourseRequirementList

All Superinterfaces:

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

public interface CourseRequirementList
extends OsidList

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

       
       
       while (crl.hasNext()) {
            CourseRequirement req = crl.getNextCourseRequirement();
       }
       
                   
       
  

or

       
       
       while (crl.hasNext()) {
            CourseRequirement[] reqs = crl.getNextCourseRequirements(crl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCourseRequirement

CourseRequirement getNextCourseRequirement()
                                           throws OperationFailedException

Gets the next CourseRequirement in this list.

Returns:

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

getNextCourseRequirements

CourseRequirement[] getNextCourseRequirements(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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