org.osid.mapping.path.batch

Interface PathBatchFormList

All Superinterfaces:

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

public interface PathBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PathBatchForm form = pbfl.getNextPathBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PathBatchForm[] forms = pbfl.getNextPathBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPathBatchForm

PathBatchForm getNextPathBatchForm()
                                   throws OperationFailedException

Gets the next PathBatchForm in this list.

Returns:

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

getNextPathBatchForms

PathBatchForm[] getNextPathBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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