org.osid.financials.budgeting

Interface BudgetList

All Superinterfaces:

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

public interface BudgetList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Budget budget = bl.getNextBudget();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Budget[] budgets = bl.getNextBudgets(bl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBudget

Budget getNextBudget()
                     throws OperationFailedException

Gets the next Budget in this list.

Returns:

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

getNextBudgets

Budget[] getNextBudgets(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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