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