org.osid.grading.batch

Interface GradeSystemBatchFormList

All Superinterfaces:

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

public interface GradeSystemBatchFormList
extends OsidList

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

       
       
       while (gsbfl.hasNext()) {
            GradeSystemBatchForm form = gsbfl.getNextGradeSystemBatchForm();
       }
       
                   
       
  

or

       
       
       while (gsbfl.hasNext()) {
            GradeSystemBatchForm[] forms = gsbfl.getNextGradeSystemBatchForms(gsbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextGradeSystemBatchForm

GradeSystemBatchForm getNextGradeSystemBatchForm()
                                                 throws OperationFailedException

Gets the next GradeSystemBatchForm in this list.

Returns:

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

getNextGradeSystemBatchForms

GradeSystemBatchForm[] getNextGradeSystemBatchForms(long n)
                                                    throws OperationFailedException

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

Parameters:

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

Returns:

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