OSID Logo
OSID Specifications
provisioning batch package
Version 3.1.0
Interfaceosid.provisioning.batch.ProvisionableBatchFormList
Implementsosid.OsidList
Used Byosid.provisioning.batch.ProvisionableBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     ProvisionableBatchForm form = pbfl.getNextProvisionableBatchForm();
}
                
or
while (pbfl.hasNext()) {
     ProvisionableBatchForm[] forms = pbfl.getNextProvisionableBatchForms(pbfl.available());
}
                
MethodgetNextProvisionableBatchForm
Description

Gets the next ProvisionableBatchForm in this list.

Returnosid.provisioning.batch.ProvisionableBatchForm the next ProvisionableBatchForm in this list. The hasNext() method should be used to test that a next ProvisionableBatchForm 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.
MethodgetNextProvisionableBatchForms
Description

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

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