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