OSID Logo
OSID Specifications
provisioning batch package
Version 3.1.0
Interfaceosid.provisioning.batch.RequestBatchFormList
Implementsosid.OsidList
Used Byosid.provisioning.batch.RequestBatchAdminSession
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.RequestBatchForm the next RequestBatchForm in this list. The hasNext() method should be used to test that a next RequestBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.