org.osid.course.requisite

Interface RequisiteList

All Superinterfaces:

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

public interface RequisiteList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            Requisite requisite = rl.getNextRequisite();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            Requisite[] requisites = rl.getNextRequisites(rl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRequisite

Requisite getNextRequisite()
                           throws OperationFailedException

Gets the next Requisite in this list.

Returns:

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

getNextRequisites

Requisite[] getNextRequisites(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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