OSID Logo
OSID Specifications
installation batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.batch.DepotBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dbfl.hasNext()) {
                          DepotBatchForm form = dbfl.getNextDepotBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dbfl.hasNext()) {
                          DepotBatchForm[] forms = dbfl.getNextDepotBatchForms(dbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextDepotBatchForm
Description

Gets the next DepotBatchForm in this list.

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

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

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