org.osid.workflow.batch

Interface ProcessBatchFormList

All Superinterfaces:

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

public interface ProcessBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            ProcessBatchForm form = pbfl.getNextProcessBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            ProcessBatchForm[] forms = pbfl.getNextProcessBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProcessBatchForm

ProcessBatchForm getNextProcessBatchForm()
                                         throws OperationFailedException

Gets the next ProcessBatchForm in this list.

Returns:

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

getNextProcessBatchForms

ProcessBatchForm[] getNextProcessBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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