org.osid.financials.batch

Interface BusinessBatchFormList

All Superinterfaces:

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

public interface BusinessBatchFormList
extends OsidList

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

       
       
       while (bbfl.hasNext()) {
            BusinessBatchForm form = bbfl.getNextBusinessBatchForm();
       }
       
                   
       
  

or

       
       
       while (bbfl.hasNext()) {
            BusinessBatchForm[] forms = bbfl.getNextBusinessBatchForms(bbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBusinessBatchForm

BusinessBatchForm getNextBusinessBatchForm()
                                           throws OperationFailedException

Gets the next BusinessBatchForm in this list.

Returns:

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

getNextBusinessBatchForms

BusinessBatchForm[] getNextBusinessBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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