OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextShipment
Description

Gets the next Shipment in this list.

Returnosid.inventory.shipment.Shipmentthe next Shipment in this list. The hasNext() method should be used to test that a next Shipment is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextShipments
Description

Gets the next set of Shipment elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinalnthe number of Shipment elements requested which must be less than or equal to available()
Returnosid.inventory.shipment.Shipment[]an array of Shipment elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.