org.osid.recognition.batch

Interface ConferralBatchFormList

All Superinterfaces:

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

public interface ConferralBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            ConferralBatchForm form = cbfl.getNextConferralBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            ConferralBatchForm[] forms = cbfl.getNextConferralBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextConferralBatchForm

ConferralBatchForm getNextConferralBatchForm()
                                             throws OperationFailedException

Gets the next ConferralBatchForm in this list.

Returns:

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

getNextConferralBatchForms

ConferralBatchForm[] getNextConferralBatchForms(long n)
                                                throws OperationFailedException

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

Parameters:

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

Returns:

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