OSID Logo
OSID Specifications
inventory shipment package
Version 3.1.0
Interfaceosid.inventory.shipment.ShipmentList
Implementsosid.OsidList
Used Byosid.inventory.shipment.ShipmentLookupSession
osid.inventory.shipment.ShipmentQuerySession
osid.inventory.shipment.ShipmentSearchResults
osid.inventory.shipment.ShipmentWarehouseSession
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.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.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.