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()); }
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. |
Budget getNextBudget() throws OperationFailedException
Budget
in this list. Budget
in this list. The
hasNext()
method should be used to test that a next
Budget
is available before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Budget[] getNextBudgets(long n) throws OperationFailedException
Budget
elements in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of Budget
elements requested which
must be less than or equal to available()
Budget
elements.
The
length of the array is less than or equal to the number
specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.