org.osid.course

Interface CourseList

All Superinterfaces:

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

public interface CourseList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Course course = cl.getNextCourse();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Course[] courses = cl.getNextCourses(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCourse

Course getNextCourse()
                     throws OperationFailedException

Gets the next Course in this list.

Returns:

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

getNextCourses

Course[] getNextCourses(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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