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