OSID Logo
OSID Specifications
offering batch package
Version 3.1.0
Interfaceosid.offering.batch.CanonicalUnitBatchFormList
Implementsosid.OsidList
Used Byosid.offering.batch.CanonicalUnitBatchAdminSession
Description

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

while (cubfl.hasNext()) {
     CanonicalUnitBatchForm form = cubfl.getNextCanonicalUnitBatchForm();
}
                
or
while (cubfl.hasNext()) {
     CanonicalUnitBatchForm[] forms = cubfl.getNextCanonicalUnitBatchForms(cubfl.available());
}
                
MethodgetNextCanonicalUnitBatchForm
Description

Gets the next CanonicalUnitBatchForm in this list.

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

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

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