org.osid.offering.batch

Interface ResultBatchFormList

All Superinterfaces:

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

public interface ResultBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            ResultBatchForm form = rbfl.getNextResultBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            ResultBatchForm[] forms = rbfl.getNextResultBatchForms(abfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResultBatchForm

ResultBatchForm getNextResultBatchForm()
                                       throws OperationFailedException

Gets the next ResultBatchForm in this list.

Returns:

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

getNextResultBatchForms

ResultBatchForm[] getNextResultBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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