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