org.osid.installation.batch

Interface DepotBatchFormList

All Superinterfaces:

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

public interface DepotBatchFormList
extends OsidList

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

       
       
       while (dbfl.hasNext()) {
            DepotBatchForm form = dbfl.getNextDepotBatchForm();
       }
       
                   
       
  

or

       
       
       while (dbfl.hasNext()) {
            DepotBatchForm[] forms = dbfl.getNextDepotBatchForms(dbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDepotBatchForm

DepotBatchForm getNextDepotBatchForm()
                                     throws OperationFailedException

Gets the next DepotBatchForm in this list.

Returns:

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

getNextDepotBatchForms

DepotBatchForm[] getNextDepotBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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