org.osid.course.syllabus

Interface SyllabusList

All Superinterfaces:

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

public interface SyllabusList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            Syllabus syllabus = sl.getNextSyllabes();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Syllabus[] syllabi = sl.getNextSyllabi(sl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSyllabus

Syllabus getNextSyllabus()
                         throws OperationFailedException

Gets the next Syllabus in this list.

Returns:

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

getNextSyllabi

Syllabus[] getNextSyllabi(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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