Interface PositionBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface PositionBatchFormList
extends OsidList

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

while (pbfl.hasNext()) {
     PositionBatchForm form = pbfl.getNextPositionBatchForm();
}            
  

or

while (pbfl.hasNext()) {
     PositionBatchForm[] forms = pbfl.getNextPositionBatchForms(pbfl.available());
}            
  

Method Summary

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

getNextPositionBatchForm

PositionBatchForm getNextPositionBatchForm()
                                    throws OperationFailedException

Gets the next PositionBatchForm in this list.

Returns:

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

getNextPositionBatchForms

PositionBatchForm[] getNextPositionBatchForms(long n)
                                       throws OperationFailedException

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

Parameters:

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

Returns:

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