org.osid.financials.budgeting.batch

Interface BudgetBatchFormList

All Superinterfaces:

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

public interface BudgetBatchFormList
extends OsidList

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

       
       
       while (bbfl.hasNext()) {
            BudgetBatchForm form = bbfl.getNextBudgetBatchForm();
       }
       
                   
       
  

or

       
       
       while (bbfl.hasNext()) {
            BudgetBatchForm[] forms = bbfl.getNextBudgetBatchForms(bbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBudgetBatchForm

BudgetBatchForm getNextBudgetBatchForm()
                                       throws OperationFailedException

Gets the next BudgetBatchForm in this list.

Returns:

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

getNextBudgetBatchForms

BudgetBatchForm[] getNextBudgetBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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