OSID Logo
OSID Specifications
inquiry batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.batch.InquestBatchFormList
Implementsosid.OsidList
Description

InquestBatchFormList provides a means for accessing InquestBatchForm elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (ibfl.hasNext()) {
                          InquestBatchForm form = ibfl.getNextInquestBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          InquestBatchForm[] forms = ibfl.getNextInquestBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextInquestBatchForm
Description

Gets the next InquestBatchForm in this list.

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

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

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