org.osid.profile.batch

Interface ProfileEntryBatchFormList

All Superinterfaces:

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

public interface ProfileEntryBatchFormList
extends OsidList

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

       
       
       while (pebfl.hasNext()) {
            ProfileEntryBatchForm form = pebfl.getNextProfileEntryBatchForm();
       }
       
                   
       
  

or

       
       
       while (pebfl.hasNext()) {
            ProfileEntryBatchForm[] forms = pebfl.getNextProfileEntryBatchForms(pebfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProfileEntryBatchForm

ProfileEntryBatchForm getNextProfileEntryBatchForm()
                                                   throws OperationFailedException

Gets the next ProfileEntryBatchForm in this list.

Returns:

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

getNextProfileEntryBatchForms

ProfileEntryBatchForm[] getNextProfileEntryBatchForms(long n)
                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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