Interface FunctionBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface FunctionBatchFormList
extends OsidList

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

while (fbfl.hasNext()) {
     FunctionBatchForm form = fbfl.getNextFunctionBatchForm();
}            
  

or

while (fbfl.hasNext()) {
     FunctionBatchForm[] forms = fbfl.getNextFunctionBatchForms(fbfl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
FunctionBatchForm	getNextFunctionBatchForm()	Gets the next FunctionBatchForm in this list.
FunctionBatchForm[]	getNextFunctionBatchForms(long n)	Gets the next set of FunctionBatchForm elements in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextFunctionBatchForm

FunctionBatchForm getNextFunctionBatchForm()
                                    throws OperationFailedException

Gets the next FunctionBatchForm in this list.

Returns:

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

getNextFunctionBatchForms

FunctionBatchForm[] getNextFunctionBatchForms(long n)
                                       throws OperationFailedException

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

Parameters:

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

Returns:

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