org.osid.learning.batch

Interface ProficiencyBatchFormList

All Superinterfaces:

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

public interface ProficiencyBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            ProficiencyBatchForm form = pbfl.getNextProficiencyBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            ProficiencyBatchForm[] forms = pbfl.getNextProficiencyBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProficiencyBatchForm

ProficiencyBatchForm getNextProficiencyBatchForm()
                                                 throws OperationFailedException

Gets the next ProficiencyBatchForm in this list.

Returns:

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

getNextProficiencyBatchForms

ProficiencyBatchForm[] getNextProficiencyBatchForms(long n)
                                                    throws OperationFailedException

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

Parameters:

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

Returns:

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