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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RequestBatchForm form = rbfl.getNextRequestBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RequestBatchForm[] forms = rbfl.getNextRequestBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRequestBatchForm
Description

Gets the next RequestBatchForm in this list.

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

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

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