org.osid.recognition

Interface ConferralList

All Superinterfaces:

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

public interface ConferralList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Conferral conferral = cl.getNextConferral();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Conferral[] conferrals = cl.getNextConferrals(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextConferral

Conferral getNextConferral()
                           throws OperationFailedException

Gets the next Conferral in this list.

Returns:

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

getNextConferrals

Conferral[] getNextConferrals(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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