org.osid.control.batch

Interface ActionGroupBatchFormList

All Superinterfaces:

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

public interface ActionGroupBatchFormList
extends OsidList

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

       
       
       while (agbfl.hasNext()) {
            ActionGroupBatchForm form = agbfl.getNextActionGroupBatchForm();
       }
       
                   
       
  

or

       
       
       while (agbfl.hasNext()) {
            ActionGroupBatchForm[] forms = agbfl.getNextActionGroupBatchForms(agbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextActionGroupBatchForm

ActionGroupBatchForm getNextActionGroupBatchForm()
                                                 throws OperationFailedException

Gets the next ActionGroupBatchForm in this list.

Returns:

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

getNextActionGroupBatchForms

ActionGroupBatchForm[] getNextActionGroupBatchForms(long n)
                                                    throws OperationFailedException

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

Parameters:

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

Returns:

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