org.osid.hold.batch

Interface BlockBatchFormList

All Superinterfaces:

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

public interface BlockBatchFormList
extends OsidList

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

       
       
       while (bbfl.hasNext()) {
            BlockBatchForm form = bbfl.getNextBlockBatchForm();
       }
       
                   
       
  

or

       
       
       while (bbfl.hasNext()) {
            BlockBatchForm[] forms = bbfl.getNextBlockBatchForms(bbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBlockBatchForm

BlockBatchForm getNextBlockBatchForm()
                                     throws OperationFailedException

Gets the next BlockBatchForm in this list.

Returns:

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

getNextBlockBatchForms

BlockBatchForm[] getNextBlockBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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