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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BrokerBatchForm form = bbfl.getNextBrokerBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BrokerBatchForm[] forms = bbfl.getNextBrokerBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBrokerBatchForm
Description

Gets the next BrokerBatchForm in this list.

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

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

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