org.osid.mapping.batch

Interface LocationBatchFormList

All Superinterfaces:

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

public interface LocationBatchFormList
extends OsidList

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

       
       
       while (lbfl.hasNext()) {
            LocationBatchForm form = lbfl.getNextLocationBatchForm();
       }
       
                   
       
  

or

       
       
       while (lbfl.hasNext()) {
            LocationBatchForm[] forms = lbfl.getNextLocationBatchForms(lbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextLocationBatchForm

LocationBatchForm getNextLocationBatchForm()
                                           throws OperationFailedException

Gets the next LocationBatchForm in this list.

Returns:

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

getNextLocationBatchForms

LocationBatchForm[] getNextLocationBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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