org.osid.provisioning.batch

Interface QueueBatchFormList

All Superinterfaces:

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

public interface QueueBatchFormList
extends OsidList

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

       
       
       while (qbfl.hasNext()) {
            QueueBatchForm form = qbfl.getNextQueueBatchForm();
       }
       
                   
       
  

or

       
       
       while (qbfl.hasNext()) {
            QueueBatchForm[] forms = qbfl.getNextQueueBatchForms(qbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextQueueBatchForm

QueueBatchForm getNextQueueBatchForm()
                                     throws OperationFailedException

Gets the next QueueBatchForm in this list.

Returns:

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

getNextQueueBatchForms

QueueBatchForm[] getNextQueueBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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