public interface FiscalPeriodBatchFormList extends OsidList
Like all OsidLists,
FiscalPeriodBatchFormList
provides a means for accessing FiscalPeriodBatchForm
elements sequentially either one at a time or many at a time.
Examples:
while (fpbfl.hasNext()) { FiscalPeriodBatchForm form = fpbfl.getNextFiscalPeriodBatchForm(); }or
while (fpbfl.hasNext()) { FiscalPeriodBatchForm[] forms = fpbfl.getNextFiscalPeriodBatchForms(fpbfl.available()); }
Modifier and Type | Method and Description |
---|---|
FiscalPeriodBatchForm |
getNextFiscalPeriodBatchForm()
Gets the next
FiscalPeriodBatchForm in this list. |
FiscalPeriodBatchForm[] |
getNextFiscalPeriodBatchForms(long n)
Gets the next set of
FiscalPeriodBatchForm elements in
this list. |
FiscalPeriodBatchForm getNextFiscalPeriodBatchForm() throws OperationFailedException
FiscalPeriodBatchForm
in this list. FiscalPeriodBatchForm
in this list.
The hasNext()
method should be used to test
that a next FiscalPeriodBatchForm
is available
before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. FiscalPeriodBatchForm[] getNextFiscalPeriodBatchForms(long n) throws OperationFailedException
FiscalPeriodBatchForm
elements in
this list. The specified amount must be less than or equal to the
return from available().
n
- the number of FiscalPeriodBatchForm
elements
requested which must be less than or equal to
available()
FiscalPeriodBatchForm
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.