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