org.osid.inquiry.batch

Interface InquiryBatchFormList

All Superinterfaces:

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

public interface InquiryBatchFormList
extends OsidList

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

       
       
       while (ibfl.hasNext()) {
            InquiryBatchForm form = ibfl.getNextInquiryBatchForm();
       }
       
                   
       
  

or

       
       
       while (ibfl.hasNext()) {
            InquiryBatchForm[] forms = ibfl.getNextInquiryBatchForms(ibfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInquiryBatchForm

InquiryBatchForm getNextInquiryBatchForm()
                                         throws OperationFailedException

Gets the next InquiryBatchForm in this list.

Returns:

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

getNextInquiryBatchForms

InquiryBatchForm[] getNextInquiryBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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