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

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

                     
                     
                     while (pbfl.hasNext()) {
                          ProvisionBatchForm form = pbfl.getNextProvisionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          ProvisionBatchForm[] forms = pbfl.getNextProvisionBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProvisionBatchForm
Description

Gets the next ProvisionBatchForm in this list.

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

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

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