Interface OffsetEventBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface OffsetEventBatchFormList
extends OsidList

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

while (cobfl.hasNext()) {
     OffsetEventBatchForm form = cobfl.getNextOffsetEventBatchForm();
}            
  

or

while (cobfl.hasNext()) {
     OffsetEventBatchForm[] forms = cobfl.getNextOffsetEventBatchForms(cobfl.available());
}            
  

Method Summary

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

getNextOffsetEventBatchForm

OffsetEventBatchForm getNextOffsetEventBatchForm()
                                          throws OperationFailedException

Gets the next OffsetEventBatchForm in this list.

Returns:

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

getNextOffsetEventBatchForms

OffsetEventBatchForm[] getNextOffsetEventBatchForms(long n)
                                             throws OperationFailedException

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

Parameters:

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

Returns:

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