org.osid.course

Interface CourseCatalogNodeList

All Superinterfaces:

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

public interface CourseCatalogNodeList
extends OsidList

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

       
       
       while (ccnl.hasNext()) {
            CourseCatalogNode node = ccnl.getNextCourseCatalogNode();
       }
       
                   
       
  

or

       
       
       while (ccnl.hasNext()) {
            CourseCatalogNode[] nodes = ccnl.getNextCourseCatalogNodes(ccnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCourseCatalogNode

CourseCatalogNode getNextCourseCatalogNode()
                                           throws OperationFailedException

Gets the next CourseCatalogNode in this list.

Returns:

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

getNextCourseCatalogNodes

CourseCatalogNode[] getNextCourseCatalogNodes(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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