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

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

                     
                     
                     while (dbfl.hasNext()) {
                          DistributorBatchForm form = dbfl.getNextDistributorBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dbfl.hasNext()) {
                          DistributorBatchForm[] forms = dbfl.getNextDistributorBatchForms(dbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextDistributorBatchForm
Description

Gets the next DistributorBatchForm in this list.

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

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

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