org.osid.workflow.batch

Interface StepBatchFormList

All Superinterfaces:

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

public interface StepBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            StepBatchForm form = sbfl.getNextStepBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            StepBatchForm[] forms = sbfl.getNextStepBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextStepBatchForm

StepBatchForm getNextStepBatchForm()
                                   throws OperationFailedException

Gets the next StepBatchForm in this list.

Returns:

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

getNextStepBatchForms

StepBatchForm[] getNextStepBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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