Interface | osid.inventory.shipment.ShipmentList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (sl.hasNext()) { Shipment shipment = sl.getNextShipment(); }or while (sl.hasNext()) { Shipment[] shipments = sl.getNextShipments(sl.available()); } | ||
Method | getNextShipment | ||
Description |
Gets the next | ||
Return | osid.inventory.shipment.Shipment | the next Shipment in this list. The hasNext()
method should be used to test that a next Shipment is available
before calling this method. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextShipments | ||
Description |
Gets the next set of | ||
Parameters | cardinal | n | the number of Shipment elements requested which must be less
than or equal to available() |
Return | osid.inventory.shipment.Shipment[] | an array of Shipment elements. The length of
the array is less than or equal to the number specified. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |