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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PackageBatchForm form = pbfl.getNextPackageBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PackageBatchForm[] forms = pbfl.getNextPackageBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPackageBatchForm
Description

Gets the next PackageBatchForm in this list.

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

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

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