OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.CanonicalUnitBatchFormList
Implementsosid.OsidList
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.CanonicalUnitBatchFormthe next CanonicalUnitBatchForm in this list. The hasNext() method should be used to test that a next CanonicalUnitBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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().

Parameterscardinalnthe 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_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.