org.osid.hold.batch

Interface HoldBatchFormList

All Superinterfaces:

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

public interface HoldBatchFormList
extends OsidList

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

       
       
       while (hbfl.hasNext()) {
            HoldBatchForm form = hbfl.getNextHoldBatchForm();
       }
       
                   
       
  

or

       
       
       while (hbfl.hasNext()) {
            HoldBatchForm[] forms = hbfl.getNextHoldBatchForms(hbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextHoldBatchForm

HoldBatchForm getNextHoldBatchForm()
                                   throws OperationFailedException

Gets the next HoldBatchForm in this list.

Returns:

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

getNextHoldBatchForms

HoldBatchForm[] getNextHoldBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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