org.osid.recognition.batch

Interface AwardBatchFormList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface AwardBatchFormList
extends OsidList

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

       
       
       while (abfl.hasNext()) {
            AwardBatchForm form = abfl.getNextAwardBatchForm();
       }
       
                   
       
  

or

       
       
       while (abfl.hasNext()) {
            AwardBatchForm[] forms = abfl.getNextAwardBatchForms(abfl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AwardBatchForm	getNextAwardBatchForm() Gets the next AwardBatchForm in this list.
AwardBatchForm[]	getNextAwardBatchForms(long n) Gets the next set of AwardBatchForm elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextAwardBatchForm

AwardBatchForm getNextAwardBatchForm()
                                     throws OperationFailedException

Gets the next AwardBatchForm in this list.

Returns:

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

getNextAwardBatchForms

AwardBatchForm[] getNextAwardBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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