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

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

                     
                     
                     while (ebfl.hasNext()) {
                          RequestTransactionBatchForm form = ebfl.getNextRequestTransactionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          RequestTransactionBatchForm[] forms = ebfl.getNextRequestTransactionBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRequestTransactionBatchForm
Description

Gets the next RequestTransactionBatchForm in this list.

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

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

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