OSID Logo
OSID Specifications
inventory batch package
Version 3.1.0
Interfaceosid.inventory.batch.StockBatchFormList
Implementsosid.OsidList
Used Byosid.inventory.batch.StockBatchAdminSession
Description

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

while (sbfl.hasNext()) {
     StockBatchForm form = sbfl.getNextStockBatchForm();
}
                
or
while (sbfl.hasNext()) {
     StockBatchForm[] forms = sbfl.getNextStockBatchForms(sbfl.available());
}
                
MethodgetNextStockBatchForm
Description

Gets the next StockBatchForm in this list.

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

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

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