org.osid.course.registration.batch

Interface RegistrationBatchFormList

All Superinterfaces:

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

public interface RegistrationBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            RegistrationBatchForm form = rbfl.getNextRegistrationBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            RegistrationBatchForm[] forms = rbfl.getNextRegistrationBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRegistrationBatchForm

RegistrationBatchForm getNextRegistrationBatchForm()
                                                   throws OperationFailedException

Gets the next RegistrationBatchForm in this list.

Returns:

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

getNextRegistrationBatchForms

RegistrationBatchForm[] getNextRegistrationBatchForms(long n)
                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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