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