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

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

                     
                     
                     while (ibfl.hasNext()) {
                          InquiryBatchForm form = ibfl.getNextInquiryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ibfl.hasNext()) {
                          InquiryBatchForm[] forms = ibfl.getNextInquiryBatchForms(ibfl.available());
                     }
                     
                                 
                     
                
MethodgetNextInquiryBatchForm
Description

Gets the next InquiryBatchForm in this list.

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

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

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