org.osid.course

Interface CourseCatalogList

All Superinterfaces:

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

public interface CourseCatalogList
extends OsidList

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

       
       
       while (ccl.hasNext()) {
            CourseCatalog catalog = ccl.getNextCourseCatalog();
       }
       
                   
       
  

or

       
       
       while (ccl.hasNext()) {
            CourseCatalog[] catalogs = ccl.getNextCourseCatalogs(ccl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCourseCatalog

CourseCatalog getNextCourseCatalog()
                                   throws OperationFailedException

Gets the next CourseCatalog in this list.

Returns:

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

getNextCourseCatalogs

CourseCatalog[] getNextCourseCatalogs(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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