org.osid.provisioning.batch

Interface RequestBatchFormList

All Superinterfaces:

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

public interface RequestBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            RequestBatchForm form = rbfl.getNextRequestBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            RequestBatchForm[] forms = rbfl.getNextRequestBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRequestBatchForm

RequestBatchForm getNextRequestBatchForm()
                                         throws OperationFailedException

Gets the next RequestBatchForm in this list.

Returns:

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

getNextRequestBatchForms

RequestBatchForm[] getNextRequestBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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