org.osid.recognition.batch

Interface ConvocationBatchFormList

All Superinterfaces:

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

public interface ConvocationBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            ConvocationBatchForm form = cbfl.getNextConvocationBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            ConvocationBatchForm[] forms = cbfl.getNextConvocationBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextConvocationBatchForm

ConvocationBatchForm getNextConvocationBatchForm()
                                                 throws OperationFailedException

Gets the next ConvocationBatchForm in this list.

Returns:

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

getNextConvocationBatchForms

ConvocationBatchForm[] getNextConvocationBatchForms(long n)
                                                    throws OperationFailedException

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

Parameters:

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

Returns:

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