org.osid.inquiry.batch

Interface ResponseBatchFormList

All Superinterfaces:

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

public interface ResponseBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            ResponseBatchForm form = rbfl.getNextResponseBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            ResponseBatchForm[] forms = rbfl.getNextResponseBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResponseBatchForm

ResponseBatchForm getNextResponseBatchForm()
                                           throws OperationFailedException

Gets the next ResponseBatchForm in this list.

Returns:

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

getNextResponseBatchForms

ResponseBatchForm[] getNextResponseBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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