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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CatalogueBatchForm form = cbfl.getNextCatalogueBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CatalogueBatchForm[] forms = cbfl.getNextCatalogueBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCatalogueBatchForm
Description

Gets the next CatalogueBatchForm in this list.

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

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

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