org.osid.checklist.batch

Interface TodoBatchFormList

All Superinterfaces:

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

public interface TodoBatchFormList
extends OsidList

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

       
       
       while (tbfl.hasNext()) {
            TodoBatchForm form = tbfl.getNextTodoBatchForm();
       }
       
                   
       
  

or

       
       
       while (tbfl.hasNext()) {
            TodoBatchForm[] forms = tbfl.getNextTodoBatchForms(tbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextTodoBatchForm

TodoBatchForm getNextTodoBatchForm()
                                   throws OperationFailedException

Gets the next TodoBatchForm in this list.

Returns:

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

getNextTodoBatchForms

TodoBatchForm[] getNextTodoBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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