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