OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.PoolBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          PoolBatchForm form = pbfl.getNextPoolBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PoolBatchForm[] forms = pbfl.getNextPoolBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPoolBatchForm
Description

Gets the next PoolBatchForm in this list.

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

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

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