org.osid.id.batch

Interface IdBatchFormList

All Superinterfaces:

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

public interface IdBatchFormList
extends OsidList

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

       
       
       while (ibfl.hasNext()) {
            IdBatchForm form = ibfl.getNextIdBatchForm();
       }
       
                   
       
  

or

       
       
       while (ibfl.hasNext()) {
            IdBatchForm[] forms = il.getNextIdBatchForms(ibfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextIdBatchForm

IdBatchForm getNextIdBatchForm()
                               throws OperationFailedException

Gets the next IdBatchForm in this list.

Returns:

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

getNextIdBatchForms

IdBatchForm[] getNextIdBatchForms(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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