org.osid.inquiry.batch

Interface InquestBatchFormList

All Superinterfaces:

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

public interface InquestBatchFormList
extends OsidList

InquestBatchFormList provides a means for accessing InquestBatchForm elements sequentially either one at a time or many at a time. Examples:

       
       
       while (ibfl.hasNext()) {
            InquestBatchForm form = ibfl.getNextInquestBatchForm();
       }
       
                   
       
  

or

       
       
       while (ibfl.hasNext()) {
            InquestBatchForm[] forms = ibfl.getNextInquestBatchForms(ibfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInquestBatchForm

InquestBatchForm getNextInquestBatchForm()
                                         throws OperationFailedException

Gets the next InquestBatchForm in this list.

Returns:

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

getNextInquestBatchForms

InquestBatchForm[] getNextInquestBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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