org.osid.room.squatting.batch

Interface LeaseBatchFormList

All Superinterfaces:

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

public interface LeaseBatchFormList
extends OsidList

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

       
       
       while (lbfl.hasNext()) {
            LeaseBatchForm form = lbfl.getNextLeaseBatchForm();
       }
       
                   
       
  

or

       
       
       while (lbfl.hasNext()) {
            LeaseBatchForm[] forms = lbfl.getNextLeaseBatchForms(lbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLeaseBatchForm

LeaseBatchForm getNextLeaseBatchForm()
                                     throws OperationFailedException

Gets the next LeaseBatchForm in this list.

Returns:

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

getNextLeaseBatchForms

LeaseBatchForm[] getNextLeaseBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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