org.osid.resource.batch

Interface BinBatchFormList

All Superinterfaces:

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

public interface BinBatchFormList
extends OsidList

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

       
       
       while (bbfl.hasNext()) {
            BinBatchForm form = bbfl.getNextBinBatchForm();
       }
       
                   
       
  

or

       
       
       while (bbfl.hasNext()) {
            BinBatchForm[] forms = bbfl.getNextBinBatchForms(bbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBinBatchForm

BinBatchForm getNextBinBatchForm()
                                 throws OperationFailedException

Gets the next BinBatchForm in this list.

Returns:

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

getNextBinBatchForms

BinBatchForm[] getNextBinBatchForms(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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