org.osid.control.batch

Interface DeviceBatchFormList

All Superinterfaces:

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

public interface DeviceBatchFormList
extends OsidList

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

       
       
       while (dbfl.hasNext()) {
            DeviceBatchForm form = dbfl.getNextDeviceBatchForm();
       }
       
                   
       
  

or

       
       
       while (dbfl.hasNext()) {
            DeviceBatchForm[] forms = dbfl.getNextDeviceBatchForms(dbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDeviceBatchForm

DeviceBatchForm getNextDeviceBatchForm()
                                       throws OperationFailedException

Gets the next DeviceBatchForm in this list.

Returns:

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

getNextDeviceBatchForms

DeviceBatchForm[] getNextDeviceBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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