OSID Logo
OSID Specifications
provisioning batch package
Version 3.1.0
Interfaceosid.provisioning.batch.DistributorBatchFormList
Implementsosid.OsidList
Used Byosid.provisioning.batch.DistributorBatchAdminSession
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.DistributorBatchForm the next DistributorBatchForm in this list. The hasNext() method should be used to test that a next DistributorBatchForm 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.
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().

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