org.osid.control.batch

Interface InputBatchFormList

All Superinterfaces:

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

public interface InputBatchFormList
extends OsidList

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

       
       
       while (ibfl.hasNext()) {
            InputBatchForm form = ibfl.getNextInputBatchForm();
       }
       
                   
       
  

or

       
       
       while (ibfl.hasNext()) {
            InputBatchForm[] forms = ibfl.getNextInputBatchForms(ibfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInputBatchForm

InputBatchForm getNextInputBatchForm()
                                     throws OperationFailedException

Gets the next InputBatchForm in this list.

Returns:

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

getNextInputBatchForms

InputBatchForm[] getNextInputBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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