org.osid.course.syllabus.batch

Interface DocetBatchFormList

All Superinterfaces:

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

public interface DocetBatchFormList
extends OsidList

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

       
       
       while (dbfl.hasNext()) {
            DocetBatchForm form = dbfl.getNextDocetBatchForm();
       }
       
                   
       
  

or

       
       
       while (dbfl.hasNext()) {
            DocetBatchForm[] forms = dbfl.getNextDocetBatchForms(dbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDocetBatchForm

DocetBatchForm getNextDocetBatchForm()
                                     throws OperationFailedException

Gets the next DocetBatchForm in this list.

Returns:

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

getNextDocetBatchForms

DocetBatchForm[] getNextDocetBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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