OSID Logo
OSID Specifications
inventory shipment batch package
Version 3.1.0
Interfaceosid.inventory.shipment.batch.ShipmentBatchFormList
Implementsosid.OsidList
Used Byosid.inventory.shipment.batch.ShipmentBatchAdminSession
Description

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

Gets the next ShipmentBatchForm in this list.

Returnosid.inventory.shipment.batch.ShipmentBatchForm the next ShipmentBatchForm in this list. The hasNext() method should be used to test that a next ShipmentBatchForm 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.
MethodgetNextShipmentBatchForms
Description

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

Parameterscardinaln the number of ShipmentBatchForm elements requested which must be less than or equal to available()
Returnosid.inventory.shipment.batch.ShipmentBatchForm[] an array of ShipmentBatchForm 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.