org.osid.resourcing.batch

Interface JobBatchFormList

All Superinterfaces:

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

public interface JobBatchFormList
extends OsidList

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

       
       
       while (jbfl.hasNext()) {
            JobBatchForm form = jbfl.getNextJobBatchForm();
       }
       
                   
       
  

or

       
       
       while (jbfl.hasNext()) {
            JobBatchForm[] forms = jbfl.getNextJobBatchForms(jbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextJobBatchForm

JobBatchForm getNextJobBatchForm()
                                 throws OperationFailedException

Gets the next JobBatchForm in this list.

Returns:

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

getNextJobBatchForms

JobBatchForm[] getNextJobBatchForms(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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