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