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