OSID Logo
OSID Specifications
inventory batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.batch.InventoryBatchFormList
Implementsosid.OsidList
Description

Like all OsidLists, InventoryBatchFormList provides a means for accessing InventoryBatchForm elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (ibfl.hasNext()) {
                          InventoryBatchForm form = ibfl.getNextInventoryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          InventoryBatchForm[] forms = ibfl.getNextInventoryBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextInventoryBatchForm
Description

Gets the next InventoryBatchForm in this list.

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

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

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