org.osid.control.batch

Interface SystemBatchFormList

All Superinterfaces:

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

public interface SystemBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            SystemBatchForm form = sbfl.getNextSystemBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            SystemBatchForm[] forms = sbfl.getNextSystemBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSystemBatchForm

SystemBatchForm getNextSystemBatchForm()
                                       throws OperationFailedException

Gets the next SystemBatchForm in this list.

Returns:

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

getNextSystemBatchForms

SystemBatchForm[] getNextSystemBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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