Interface ObstacleBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface ObstacleBatchFormList
extends OsidList

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

while (obfl.hasNext()) {
     ObstacleBatchForm form = obfl.getNextObstacleBatchForm();
}            
  

or

while (obfl.hasNext()) {
     ObstacleBatchForm[] forms = obfl.getNextObstacleBatchForms(obfl.available());
}            
  

Method Summary

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

getNextObstacleBatchForm

ObstacleBatchForm getNextObstacleBatchForm()
                                    throws OperationFailedException

Gets the next ObstacleBatchForm in this list.

Returns:

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

getNextObstacleBatchForms

ObstacleBatchForm[] getNextObstacleBatchForms(long n)
                                       throws OperationFailedException

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

Parameters:

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

Returns:

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