org.osid.recipe.batch

Interface CookbookBatchFormList

All Superinterfaces:

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

public interface CookbookBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            CookbookBatchForm form = cbfl.getNextCookbookBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            CookbookBatchForm[] forms = cbfl.getNextCookbookBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCookbookBatchForm

CookbookBatchForm getNextCookbookBatchForm()
                                           throws OperationFailedException

Gets the next CookbookBatchForm in this list.

Returns:

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

getNextCookbookBatchForms

CookbookBatchForm[] getNextCookbookBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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