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