org.osid.resourcing.batch

Interface WorkBatchFormList

All Superinterfaces:

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

public interface WorkBatchFormList
extends OsidList

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

       
       
       while (wbfl.hasNext()) {
            WorkBatchForm form = wbfl.getNextWorkBatchForm();
       }
       
                   
       
  

or

       
       
       while (wbfl.hasNext()) {
            WorkBatchForm[] forms = wbfl.getNextWorkBatchForms(wbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextWorkBatchForm

WorkBatchForm getNextWorkBatchForm()
                                   throws OperationFailedException

Gets the next WorkBatchForm in this list.

Returns:

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

getNextWorkBatchForms

WorkBatchForm[] getNextWorkBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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