OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.OfferingBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (obfl.hasNext()) {
                          OfferingBatchForm form = obfl.getNextOfferingBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (obfl.hasNext()) {
                          OfferingBatchForm[] forms = obfl.getNextOfferingBatchForms(obfl.available());
                     }
                     
                                 
                     
                
MethodgetNextOfferingBatchForm
Description

Gets the next OfferingBatchForm in this list.

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

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

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