Interface AvailabilityBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface AvailabilityBatchFormList
extends OsidList

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

while (abfl.hasNext()) {
     AvailabilityBatchForm form = abfl.getNextAvailabilityBatchForm();
}            
  

or

while (abfl.hasNext()) {
     AvailabilityBatchForm[] forms = abfl.getNextAvailabilityBatchForms(abfl.available());
}            
  

Method Summary

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

getNextAvailabilityBatchForm

AvailabilityBatchForm getNextAvailabilityBatchForm()
                                            throws OperationFailedException

Gets the next AvailabilityBatchForm in this list.

Returns:

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

getNextAvailabilityBatchForms

AvailabilityBatchForm[] getNextAvailabilityBatchForms(long n)
                                               throws OperationFailedException

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

Parameters:

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

Returns:

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